Izara Wiki - User contributions [en]

Per Service Schemas

2026-08-25T02:44:14Z

Seagame: /* ObjectSchema | ObjectFieldSchema.js */

= Overview =

Each service manages a schema of object/resources that it is responsible for, this schema is available to other services and frontends. The schema includes a list of fields available for each object.

= File Structure =

* see [[Repository structure#schemas|Repository structure]]

= ObjectSchema | ObjectFieldSchema.js =

== Not extendObjType ==

<syntaxhighlight lang="javascript">
{
objectType: "xx",
shortNameObjectType:"x", // optional, use when generate code create lambda role with long name
canDelete: false, // whether any fields can be deleted // default = false
belongTo: {
serviceTag:"iii",
objectType:"jjj"
},
// how is the object created
// userGenerated there will be generated endpoints for api or sqs (used in importBatchMain) to create object
// systemGenerated must be created by flow/s
// searchResultGenerated see separate notes below
generatedBy: "xx", // "user"|"systemNoUserId"|"systemWithUserId"|"searchResultGenerated" // required
searchResultGeneratedFlowType: {}, // for generatedBy = searchResultGenerated
addOnDataStructure: [ // optional, add for additional setting to objectType
{
// all fields that a user can edit must be in versionedData, and all fields in versionedData must be editable by user
type:"versionedData",
versionedDataLabel: "xx", // versionedData label name
storageResourceTag : "xx", // ref to storegeResourceTag
fieldNames: { // fieldName in versionedData cannot have in in main objectSchema.fieldNames
"aaa":{ // fieldName
type: "xx", // string|integer|number|timestamp|currency|currencyValue|float|special|object|boolean|arrayMixed|arrayNumeric|arrayString
requiredOnCreate: false, // default = false
optionalOnCreate: false, // default = false,
validation: {
itemValidation:{} // for validate item in array
},
// probably impossible to have fromObjType, because data can be changed by user here
fromObjType:{
serviceTag: "xxx",
objectType: "xxx"
},
},
// ...
}
},
{ // can have multiple addOn of type attributeTree
type:"attributeTree",
},
{
type:"translation"
},
{
type:"propertyValue"
},
{
type:"mediaLink"
},
{
type:"rbac",
billalble:true // true || false , required
},
// ...
],
plugInTags: ["a", "b"], // plugIns that can be connected to this objType
storageResources:{
"xxx":{ // storageResourceTag
storageType: "xx", // graph
graphServerTag: "xx", // setting for storageType graph
additionalGraphIndexes:[['fieldName1', 'fieldName2', ...], [...]] // will make graph index with specific fieldName
},
"zzz":{ // storageResourceTag
storageType: "xx", // dynamoDB
// setting for storageType dynamoDB
tableName: "xx",
groupByPartitionKeyField: "xx", // use groupByPartitionKeyField as partition key and not have sort key in dynamoDB, if have multiple identifiers will concat it. And use it as partitionKey.
serviceTag:"zz"// default own service.
}
},
fieldNames: {
xxx: { // fieldName
type: "xx", // string|integer|number|timestamp|currency|currencyValue|float|special|object|boolean|arrayMixed|arrayNumeric|arrayString
randomOnCreate: false, // default = false , can set true in fieldName that part of identifiers and identifiers have single identifierFieldname
requiredOnCreate: false, // default = false
optionalOnCreate: false, // default = false
canUpdate: true, // default = true (only system/flows can edit, no history of changes unless flow manually adds)
validation: {
itemValidation:{} // for validate item in array
}, // maybe ajv syntax
storageResourceTags: ["xx","yy"], // reference to storageResources property
fromObjType:{
serviceTag: "xxx",
objectType: "xxx"
},
hashOnCreate: ["xx", "yy"], // reference to other fieldName,
statusField: true, // use for objectSchema inside flowSchema, identify which field is statusField

// comes from requiredOnCreate relationships
fromRequiredOnCreate: {
relType: {
serviceTag:"aa",
relationshipTag:"bb"
},
// or
belongToObjType: true, // if set to true use the belongTo relationship to belongTo objType

fieldName:"" // optional default= same field name eg: now default == xxx if not defined(use fieldname of object inside link when create)
}
},
// ...
},
compositeKeyDeliminator: "xx", // join partitionKey and sortKey
identifiers: [
// for dynamoDB storageType
{
type: "partitionKey",

fieldNames: ["xx","yy"], // composite partition keys in DynamoDB
deliminator: "xx", // optional, defaults to "_"
name: "zz", // name of field in database
// or
fieldName: "xx"

},
{
type: "sortKey",

fieldNames: ["xx","yy"], // composite partition keys in DynamoDB
deliminator: "xx", // optional, defaults to "_"
name: "zz", // name of field in database
// or
fieldName: "xx"

},

// for graph storageType
{
type: "identifier",
fieldNames: ["xx","yy"], // identifier field in graph or composite partition keys in DynamoDB
name: "zzz" // use when save in dynamoDB partitionKey
deliminator: "xx", // optional, defaults to "_"
// or
fieldName: "xx"
},
]
}
</syntaxhighlight>

== extendObjType ==

<syntaxhighlight lang="javascript">
{
// for objects stored in graph this will add another node label
objectType: "xx", // new label to add
extendObjType: { // core object that this object extends
serviceTag: "xxx",
objectType: "xxx"
},
addOnDataStructure: [],
storageResources:{ // these are the storageResources that carry the extended objects settings,
// (see above)
},
fieldNames: {
// (see above)
},
// canDelete/identifiers come from the core object
}
</syntaxhighlight>

== searchResultGenerated ==

* must be created by flow
* eg: variantProduct
* not have any storageResources
* identifiers are automatically searchResultData identifiers
* a searchResult request for this object will enter the searchResultGeneratedFlowType flow which creates searchResultData that can then be queried/sorted
* all relationships must be storageType = lambda, eg translate from variantProduct to variant uses a translateId flow to query the variantProduct identifier (searchResultData) to find the variantId in it's requiredData results
* searchResultGeneratedFlowType takes over after creating searchResultMain record until processRequiredData
* if objectSchema defines any fieldnames, then they are found using a flow, maybe as hooks in per service findData
* when finding direct fieldname, will need to check if requireData already exists, if not enter flow/findData to create
* no fields can be edited, so can show in forms but no updates performed

= Relationships Schema | ObjectRelationships.js =

* stored in top level schemas folder
* parent/child determines relationship direction for graph relationships
* have one service that contains information of each relationship

<syntaxhighlight lang="javascript">
// relationship schema in responsible service
[
{
"xxx": { // relationshipTag - name of relationship type stored in graph
generatedBy: "xx", // "user"|"systemNoUserId"|"systemWithUserId"
canChangeToRelTypes: [
{
relType: { // relType that this relType can change to
serviceTag:"xxx",
relationshipTag: "yyy"
},
changeBy: "xx", // "user"|"systemNoUserId"|"systemWithUserId"
}
// another relType
],
storageResources:{
"xxx":{ // storageResourceTag
storageType: "xx", // dynamoDB | graph | lambda
// if storageType="dynamoDB" will not specify tableName in relationship schema

// setting for storageType graph
graphServerTag: "xx",
additionalGraphIndexes:[['fieldName1', 'fieldName2', ...], [...]], // will make graph index with specific fieldName

// setting for storageType lambda
serviceTag: "xx",
functionName: "xx",
}
},
fieldNames: {
"xxx": { // relationship property name
type: "string", // "string" | "number" ...
requiredOnCreate: false, // default=false
optionalOnCreate: false, // default = false
updateBy: "xx", // "user"|"systemNoUserId"|"systemWithUserId"|"none"
validation: {} // ajv syntax
},
//...other relationship properties
},
links: [
{
storageResourceTags: ["xxx"], // reference from storageResources property
canDelete: false // default = false, if set true will allow delete relationship between 2 objType
from: {
objType: {
serviceTag: "xx",
objectType: "xx"
},
requiredOnCreate: true, // if set true will create relationshipTag when create objType data, if both "from" and "to" linkType="many" should not have requiredOnCreate, exists in "from" or "to" only
linkType: "", // one | many
// moveBy: "xx", // "user"|"systemNoUserId"|"systemWithUserId"|"none"
// belongTo:true
},
to: {
objType: {
serviceTag: "yy",
objectType: "yy"
},
linkType: "", // one | many
// moveBy allows the relationship to be moved between 2 instances of the same objType only
moveBy: "xx", // "user"|"systemNoUserId"|"systemWithUserId"|"none"
belongTo:true, // false
},
requestProperties: {
// if storageType is Lambda and translateIds/linkPath requires properties set them here (eg sellOffer>orderPrice)
tag_deliverTo: {
requestPropertyType: "objectIdentifier",
objType: {
serviceTag: "Locations",
objectType: "locationNode" // deliversToLocationNode
},
identifiersFieldName: "locationNodeId"
},
// ... other request properties
}
}
// ...other link
]
}
}
]

</syntaxhighlight>

= Reference Relationships Schema | RefObjectRelationships.js =

<syntaxhighlight lang="javascript">
// reference to relationshipTag in external service
[
{
objectType: "zz", // objectType in local service
relationshipTag: "xxx", // name of relationshiptag of objType
relationshipServiceTag: "xx" // point to service tag that contain data of relationshipTag of objType
}
]

</syntaxhighlight>

= Flow Schema | FlowSchemas.js =

<syntaxhighlight lang="javascript">
[
{
flowTag: "yyy",
initiateBy: "xx", // "user"|"systemNoUserId"|"systemWithUserId"
handleObj: "one", // "one" | "multi"
statusType: "statusField", // "statusField" | "storedCache" | "none" | "triggerCache"

// statusType="triggerCache" setting
triggerType: "storedCache", // "storedCache" | "switch"
triggerFlowTypes: [
//... triggerFlowType
],

// statusType="statusField" | "triggerCache" | "storedCache" setting:
objType: {},

event: ["ownTopic"], // "ownTopic" | "extTopic" | "s3" | "eventBridge" | "lambdaSyncInv" | "lambdaSyncApi" | "generatedCode" | "dsq"

// event="s3" setting
bucketName: "xxx", // bucket for s3 event
createBucket: boolean, // if true will generate new bucket with bucketName if false will point to old bucket that already have

// event="eventBridge" setting
schedules: [
{
name: 'your-scheduled-rate-event-name',
description: 'your scheduled rate event description',
rate: ["rate(1 minute)",],
input: {}
}
],

outputTopic: boolean,

flowSteps: {
inTag: { // will generate Topic serviceTag_stage_yyy_inTag
properties: [], // reference to stepProperties key, the first lambda's input properties and messageAttributes are the flow's input properties and messageAttributes
messageAttributes: [], // reference to stepProperties key
plugInHooks: [
{
plugInHookTag: "",
objType: {}, // used to query connection dynamo for an object instance in current flow
},
],
returnValues: {
properties: [], // reference to stepProperties key
messageAttributes: [], // reference to stepProperties key, only for outputTopic=true
},

},
// another flow steps
flowStep1: { // will generate Topic serviceTag_stage_yyy_Flow1
properties: [], // reference to stepProperties key
messageAttributes: [], // reference to stepProperties key
event: ["ownTopic"], // "ownTopic" | "extTopic" | "s3" | "eventBridge" | "lambdaSyncInv" | "lambdaSyncApi" | "generatedCode" | "dsq"
// handle splitting logic into awaitingStep/awaitingMultipleSteps
// handle splitting logic into paginated lambda

previousSteps: [
{
sourceType:"ownTopic", // if from own flow
stepName: "xxx",
},
{
sourceType: "extTopic", // triggered by output from external service
serviceTag: "InventoryService",
topic: "ReserveStock_In",
fromStepNames: ["xx"] // which step in this flow sent request to external flow, used to find awaitingStep prefix
}
],
nextSteps: [
{
targetType:"ownTopic", // if from own flow
stepName: "yyy"
},
{
targetType: "extTopic",
serviceTag: "InventoryService",
topic: "ReserveStock_In",
toStepNames: ["xx"] // which step in this flow sent request to external flow, used to find awaitingStep prefix
}
],

plugInHooks: [
{
plugInHookTag: "",
objType: {}, // used to query connection dynamo for an object instance in current flow
},
],
returnValues: { // the last lambda function returnValues are the flow's returnValues
properties: [], // reference to stepProperties key
messageAttributes: [], // reference to stepProperties key, only for outputTopic=true
},

},
},

stepProperties: { // normalized all stepProperties
"uuid": {
propertyName: "xxx",
type: "object",
required: false, // true | false default=false
childProperties: ["uuid2", "uuid3"]
},
"uuid2": {
propertyName: "xxx",
required: false, // true | false default=false
type: "string",
},
"uuid3": {
propertyName: "xxx",
required: false, // true | false default=false
type: "string",
},
"uuid4": {
required: false, // true | false default=false
objectField: {
objType: {},
fieldName: "xx"
},
overwritePropertyName: "xx" // optional, if have objectField and have overwritePropertyName will overwrite fieldName
}
},
stepMessageAttributes: { // normalized all stepMessageAttributes
"uuid": {
propertyName: "xxx",
required: false, // true | false default=false
type: "string",
},
"uuid2": {
propertyName: "yyy",
required: false, // true | false default=false
type: "string",
}
},
}
]
</syntaxhighlight>

= System Text Schema | SystemTextSchemas.js =

<syntaxhighlight lang="javascript">
[
{
namespace: "xxx", // groups files downloaded by frontend
systemTextTag: "yyy",
}
]
</syntaxhighlight>

== Auto generated systemText and namespaces ==

=== systemNotification names ===

* namespace: "sysNotification_{notificationGrouping}"
* systemTextTag: "{notificationTag}"
* eg shown on notification settings page

=== objType names ===

* namespace: "objTypes"
* systemTextTag: "{serviceTag}_{objectType}"
* eg shown on config pages, eg pulldown list of object types

=== objType field name descriptions ===

* namespace: "objType_fielddesc_{serviceTag}_{objectType}"
* systemTextTag: "{fieldname}"
* eg shown on config pages, eg info box for each field name

= System Notification Schema | SystemNotificationSchemas.js =

<syntaxhighlight lang="javascript">
[
{
notificationTag: "xxx",
notificationGrouping: "yyy",
weight: "##",
},
]
</syntaxhighlight>

= Generated S3 files =

* generate multiple files for different uses, eg:
*# list of saved fieldNames for Create
*# list of saved+calculated for Update/Info pages
*# graphSchemas
*# relationships (used by Search/Sort Results)

= Use Cases =

== Find Deployed Service Name ==

* other services can use fixed serviceTag to get deployed serviceName from serviceSchema on S3
* used to build resource names for external services
* eg when one service needs to send a message into an SNS belonging to a different service

== Standard Create, Update, List, Delete pages ==

* List and Delete are maybe not required, use table data system instead.
* object schema can add validation information that can be used on the frontend to check before sending to backend, and by the backend to validate the data before handling

=== Create Object ===

* can configure what fields are shown
* requiredOnCreate fields must be shown

=== Edit Object ===

* users setup any number of pages for object types with configurable fields shown
* fields can be either display only or edit
* each field can adjust it's display properties (perhaps via cssStyles)

== Menu Config ==

When adding menu items can add links to create, update, list, delete objects, user chooses the service then from that service's list of objects and what action is being performed. For update/delete perhaps links to a standard page that asks for the identifier before presenting the page.

== Tabled Data ==

When viewing tabled data the frontend pulls the tableId's config from backend, then when requesting the data also requests the serviceTag > objectType schema for use when displaying the data.

== Code Standardization ==

Code such as middleware validation schema and saving data to databases can be standardized.

== Code Generation ==

Endpoints per object for actions such as Create/Delete/Update can be automatically generated from objectSchema.

=== Code Generation Structure ===

* npm for generic code generation, can be used in any project, includes functions for generating Source files from templates and developer files
* npm for per project specific files, eg templates for the project (Create/Update/.. code)
* Empty Service Template has GenerateCode.js script file in root dir that is run to generate code, it invokes a generation function from generic npm with param that points to per project npm's templates
* generated Source retains hook tags (and any developer added code), so if developer wants to update developer's file with updated template code they can generate code and simply copy generated Source to src folder

= Graph Server Config =

* S3 has a list of graphServerTag's linking to the GraphHandler serviceTag responsible for the graph
* multiple graphServerTags can point to one GraphHandler, combining graphs into one server
* when creating each GraphHandler's graph schemas, for each field split out the fields into each GraphHandler using the graphServerTag, if multiple graphServerTags for a field point to the same GraphHandler combine the fields to create GraphHandler's graph schema
* every GraphHandler an object is saved into will require it's identifiers
* when eg updating fields for an object separate the fields per GraphHandler before sending the request to update each graph

= Extended Object Types =

* Allows for one graph node to have multiple labels
* graph schema is created for both the core object and the extended object
* eg Media Manager's has a node schema for "media" object type, and Image service has a node schema for "image" object type
* the extended object builds it's schema by combining core + extended settings

= Working documents =

[[:Category:Working_documents - Per Service Schemas|Per Service Schemas]]

Per Service Schemas

2026-08-24T02:41:27Z

Seagame:

= Overview =

Each service manages a schema of object/resources that it is responsible for, this schema is available to other services and frontends. The schema includes a list of fields available for each object.

= File Structure =

* see [[Repository structure#schemas|Repository structure]]

= ObjectSchema | ObjectFieldSchema.js =

== Not extendObjType ==

<syntaxhighlight lang="javascript">
{
objectType: "xx",
shortNameObjectType:"x", // optional, use when generate code create lambda role with long name
canDelete: false, // whether any fields can be deleted // default = false
belongTo: {
serviceTag:"iii",
objectType:"jjj"
},
// how is the object created
// userGenerated there will be generated endpoints for api or sqs (used in importBatchMain) to create object
// systemGenerated must be created by flow/s
// searchResultGenerated see separate notes below
generatedBy: "xx", // "user"|"systemNoUserId"|"systemWithUserId"|"searchResultGenerated" // required
searchResultGeneratedFlowType: {}, // for generatedBy = searchResultGenerated
addOnDataStructure: [ // optional, add for additional setting to objectType
{
// all fields that a user can edit must be in versionedData, and all fields in versionedData must be editable by user
type:"versionedData",
versionedDataLabel: "xx", // versionedData label name
storageResourceTag : "xx", // ref to storegeResourceTag
fieldNames: { // fieldName in versionedData cannot have in in main objectSchema.fieldNames
"aaa":{ // fieldName
type: "xx", // string|integer|number|timestamp|currency|currencyValue|float|special|object|boolean|arrayMixed|arrayNumeric|arrayString
requiredOnCreate: false, // default = false
optionalOnCreate: false, // default = false,
validation: {
itemValidation:{} // for validate item in array
},
// probably impossible to have fromObjType, because data can be changed by user here
fromObjType:{
serviceTag: "xxx",
objectType: "xxx"
},
},
// ...
}
},
{ // can have multiple addOn of type attributeTree
type:"attributeTree",
},
{
type:"translation"
},
{
type:"propertyValue"
},
{
type:"mediaLink"
},
{
type:"rbac",
billalble:true // default:true
},
// ...
],
plugInTags: ["a", "b"], // plugIns that can be connected to this objType
storageResources:{
"xxx":{ // storageResourceTag
storageType: "xx", // graph
graphServerTag: "xx", // setting for storageType graph
additionalGraphIndexes:[['fieldName1', 'fieldName2', ...], [...]] // will make graph index with specific fieldName
},
"zzz":{ // storageResourceTag
storageType: "xx", // dynamoDB
// setting for storageType dynamoDB
tableName: "xx",
groupByPartitionKeyField: "xx", // use groupByPartitionKeyField as partition key and not have sort key in dynamoDB, if have multiple identifiers will concat it. And use it as partitionKey.
serviceTag:"zz"// default own service.
}
},
fieldNames: {
xxx: { // fieldName
type: "xx", // string|integer|number|timestamp|currency|currencyValue|float|special|object|boolean|arrayMixed|arrayNumeric|arrayString
randomOnCreate: false, // default = false , can set true in fieldName that part of identifiers and identifiers have single identifierFieldname
requiredOnCreate: false, // default = false
optionalOnCreate: false, // default = false
canUpdate: true, // default = true (only system/flows can edit, no history of changes unless flow manually adds)
validation: {
itemValidation:{} // for validate item in array
}, // maybe ajv syntax
storageResourceTags: ["xx","yy"], // reference to storageResources property
fromObjType:{
serviceTag: "xxx",
objectType: "xxx"
},
hashOnCreate: ["xx", "yy"], // reference to other fieldName,
statusField: true, // use for objectSchema inside flowSchema, identify which field is statusField

// comes from requiredOnCreate relationships
fromRequiredOnCreate: {
relType: {
serviceTag:"aa",
relationshipTag:"bb"
},
// or
belongToObjType: true, // if set to true use the belongTo relationship to belongTo objType

fieldName:"" // optional default= same field name eg: now default == xxx if not defined(use fieldname of object inside link when create)
}
},
// ...
},
compositeKeyDeliminator: "xx", // join partitionKey and sortKey
identifiers: [
// for dynamoDB storageType
{
type: "partitionKey",

fieldNames: ["xx","yy"], // composite partition keys in DynamoDB
deliminator: "xx", // optional, defaults to "_"
name: "zz", // name of field in database
// or
fieldName: "xx"

},
{
type: "sortKey",

fieldNames: ["xx","yy"], // composite partition keys in DynamoDB
deliminator: "xx", // optional, defaults to "_"
name: "zz", // name of field in database
// or
fieldName: "xx"

},

// for graph storageType
{
type: "identifier",
fieldNames: ["xx","yy"], // identifier field in graph or composite partition keys in DynamoDB
name: "zzz" // use when save in dynamoDB partitionKey
deliminator: "xx", // optional, defaults to "_"
// or
fieldName: "xx"
},
]
}
</syntaxhighlight>

== extendObjType ==

<syntaxhighlight lang="javascript">
{
// for objects stored in graph this will add another node label
objectType: "xx", // new label to add
extendObjType: { // core object that this object extends
serviceTag: "xxx",
objectType: "xxx"
},
addOnDataStructure: [],
storageResources:{ // these are the storageResources that carry the extended objects settings,
// (see above)
},
fieldNames: {
// (see above)
},
// canDelete/identifiers come from the core object
}
</syntaxhighlight>

== searchResultGenerated ==

* must be created by flow
* eg: variantProduct
* not have any storageResources
* identifiers are automatically searchResultData identifiers
* a searchResult request for this object will enter the searchResultGeneratedFlowType flow which creates searchResultData that can then be queried/sorted
* all relationships must be storageType = lambda, eg translate from variantProduct to variant uses a translateId flow to query the variantProduct identifier (searchResultData) to find the variantId in it's requiredData results
* searchResultGeneratedFlowType takes over after creating searchResultMain record until processRequiredData
* if objectSchema defines any fieldnames, then they are found using a flow, maybe as hooks in per service findData
* when finding direct fieldname, will need to check if requireData already exists, if not enter flow/findData to create
* no fields can be edited, so can show in forms but no updates performed

= Relationships Schema | ObjectRelationships.js =

* stored in top level schemas folder
* parent/child determines relationship direction for graph relationships
* have one service that contains information of each relationship

<syntaxhighlight lang="javascript">
// relationship schema in responsible service
[
{
"xxx": { // relationshipTag - name of relationship type stored in graph
generatedBy: "xx", // "user"|"systemNoUserId"|"systemWithUserId"
canChangeToRelTypes: [
{
relType: { // relType that this relType can change to
serviceTag:"xxx",
relationshipTag: "yyy"
},
changeBy: "xx", // "user"|"systemNoUserId"|"systemWithUserId"
}
// another relType
],
storageResources:{
"xxx":{ // storageResourceTag
storageType: "xx", // dynamoDB | graph | lambda
// if storageType="dynamoDB" will not specify tableName in relationship schema

// setting for storageType graph
graphServerTag: "xx",
additionalGraphIndexes:[['fieldName1', 'fieldName2', ...], [...]], // will make graph index with specific fieldName

// setting for storageType lambda
serviceTag: "xx",
functionName: "xx",
}
},
fieldNames: {
"xxx": { // relationship property name
type: "string", // "string" | "number" ...
requiredOnCreate: false, // default=false
optionalOnCreate: false, // default = false
updateBy: "xx", // "user"|"systemNoUserId"|"systemWithUserId"|"none"
validation: {} // ajv syntax
},
//...other relationship properties
},
links: [
{
storageResourceTags: ["xxx"], // reference from storageResources property
canDelete: false // default = false, if set true will allow delete relationship between 2 objType
from: {
objType: {
serviceTag: "xx",
objectType: "xx"
},
requiredOnCreate: true, // if set true will create relationshipTag when create objType data, if both "from" and "to" linkType="many" should not have requiredOnCreate, exists in "from" or "to" only
linkType: "", // one | many
// moveBy: "xx", // "user"|"systemNoUserId"|"systemWithUserId"|"none"
// belongTo:true
},
to: {
objType: {
serviceTag: "yy",
objectType: "yy"
},
linkType: "", // one | many
// moveBy allows the relationship to be moved between 2 instances of the same objType only
moveBy: "xx", // "user"|"systemNoUserId"|"systemWithUserId"|"none"
belongTo:true, // false
},
requestProperties: {
// if storageType is Lambda and translateIds/linkPath requires properties set them here (eg sellOffer>orderPrice)
tag_deliverTo: {
requestPropertyType: "objectIdentifier",
objType: {
serviceTag: "Locations",
objectType: "locationNode" // deliversToLocationNode
},
identifiersFieldName: "locationNodeId"
},
// ... other request properties
}
}
// ...other link
]
}
}
]

</syntaxhighlight>

= Reference Relationships Schema | RefObjectRelationships.js =

<syntaxhighlight lang="javascript">
// reference to relationshipTag in external service
[
{
objectType: "zz", // objectType in local service
relationshipTag: "xxx", // name of relationshiptag of objType
relationshipServiceTag: "xx" // point to service tag that contain data of relationshipTag of objType
}
]

</syntaxhighlight>

= Flow Schema | FlowSchemas.js =

<syntaxhighlight lang="javascript">
[
{
flowTag: "yyy",
initiateBy: "xx", // "user"|"systemNoUserId"|"systemWithUserId"
handleObj: "one", // "one" | "multi"
statusType: "statusField", // "statusField" | "storedCache" | "none" | "triggerCache"

// statusType="triggerCache" setting
triggerType: "storedCache", // "storedCache" | "switch"
triggerFlowTypes: [
//... triggerFlowType
],

// statusType="statusField" | "triggerCache" | "storedCache" setting:
objType: {},

event: ["ownTopic"], // "ownTopic" | "extTopic" | "s3" | "eventBridge" | "lambdaSyncInv" | "lambdaSyncApi" | "generatedCode" | "dsq"

// event="s3" setting
bucketName: "xxx", // bucket for s3 event
createBucket: boolean, // if true will generate new bucket with bucketName if false will point to old bucket that already have

// event="eventBridge" setting
schedules: [
{
name: 'your-scheduled-rate-event-name',
description: 'your scheduled rate event description',
rate: ["rate(1 minute)",],
input: {}
}
],

outputTopic: boolean,

flowSteps: {
inTag: { // will generate Topic serviceTag_stage_yyy_inTag
properties: [], // reference to stepProperties key, the first lambda's input properties and messageAttributes are the flow's input properties and messageAttributes
messageAttributes: [], // reference to stepProperties key
plugInHooks: [
{
plugInHookTag: "",
objType: {}, // used to query connection dynamo for an object instance in current flow
},
],
returnValues: {
properties: [], // reference to stepProperties key
messageAttributes: [], // reference to stepProperties key, only for outputTopic=true
},

},
// another flow steps
flowStep1: { // will generate Topic serviceTag_stage_yyy_Flow1
properties: [], // reference to stepProperties key
messageAttributes: [], // reference to stepProperties key
event: ["ownTopic"], // "ownTopic" | "extTopic" | "s3" | "eventBridge" | "lambdaSyncInv" | "lambdaSyncApi" | "generatedCode" | "dsq"
// handle splitting logic into awaitingStep/awaitingMultipleSteps
// handle splitting logic into paginated lambda

previousSteps: [
{
sourceType:"ownTopic", // if from own flow
stepName: "xxx",
},
{
sourceType: "extTopic", // triggered by output from external service
serviceTag: "InventoryService",
topic: "ReserveStock_In",
fromStepNames: ["xx"] // which step in this flow sent request to external flow, used to find awaitingStep prefix
}
],
nextSteps: [
{
targetType:"ownTopic", // if from own flow
stepName: "yyy"
},
{
targetType: "extTopic",
serviceTag: "InventoryService",
topic: "ReserveStock_In",
toStepNames: ["xx"] // which step in this flow sent request to external flow, used to find awaitingStep prefix
}
],

plugInHooks: [
{
plugInHookTag: "",
objType: {}, // used to query connection dynamo for an object instance in current flow
},
],
returnValues: { // the last lambda function returnValues are the flow's returnValues
properties: [], // reference to stepProperties key
messageAttributes: [], // reference to stepProperties key, only for outputTopic=true
},

},
},

stepProperties: { // normalized all stepProperties
"uuid": {
propertyName: "xxx",
type: "object",
required: false, // true | false default=false
childProperties: ["uuid2", "uuid3"]
},
"uuid2": {
propertyName: "xxx",
required: false, // true | false default=false
type: "string",
},
"uuid3": {
propertyName: "xxx",
required: false, // true | false default=false
type: "string",
},
"uuid4": {
required: false, // true | false default=false
objectField: {
objType: {},
fieldName: "xx"
},
overwritePropertyName: "xx" // optional, if have objectField and have overwritePropertyName will overwrite fieldName
}
},
stepMessageAttributes: { // normalized all stepMessageAttributes
"uuid": {
propertyName: "xxx",
required: false, // true | false default=false
type: "string",
},
"uuid2": {
propertyName: "yyy",
required: false, // true | false default=false
type: "string",
}
},
}
]
</syntaxhighlight>

= System Text Schema | SystemTextSchemas.js =

<syntaxhighlight lang="javascript">
[
{
namespace: "xxx", // groups files downloaded by frontend
systemTextTag: "yyy",
}
]
</syntaxhighlight>

== Auto generated systemText and namespaces ==

=== systemNotification names ===

* namespace: "sysNotification_{notificationGrouping}"
* systemTextTag: "{notificationTag}"
* eg shown on notification settings page

=== objType names ===

* namespace: "objTypes"
* systemTextTag: "{serviceTag}_{objectType}"
* eg shown on config pages, eg pulldown list of object types

=== objType field name descriptions ===

* namespace: "objType_fielddesc_{serviceTag}_{objectType}"
* systemTextTag: "{fieldname}"
* eg shown on config pages, eg info box for each field name

= System Notification Schema | SystemNotificationSchemas.js =

<syntaxhighlight lang="javascript">
[
{
notificationTag: "xxx",
notificationGrouping: "yyy",
weight: "##",
},
]
</syntaxhighlight>

= Generated S3 files =

* generate multiple files for different uses, eg:
*# list of saved fieldNames for Create
*# list of saved+calculated for Update/Info pages
*# graphSchemas
*# relationships (used by Search/Sort Results)

= Use Cases =

== Find Deployed Service Name ==

* other services can use fixed serviceTag to get deployed serviceName from serviceSchema on S3
* used to build resource names for external services
* eg when one service needs to send a message into an SNS belonging to a different service

== Standard Create, Update, List, Delete pages ==

* List and Delete are maybe not required, use table data system instead.
* object schema can add validation information that can be used on the frontend to check before sending to backend, and by the backend to validate the data before handling

=== Create Object ===

* can configure what fields are shown
* requiredOnCreate fields must be shown

=== Edit Object ===

* users setup any number of pages for object types with configurable fields shown
* fields can be either display only or edit
* each field can adjust it's display properties (perhaps via cssStyles)

== Menu Config ==

When adding menu items can add links to create, update, list, delete objects, user chooses the service then from that service's list of objects and what action is being performed. For update/delete perhaps links to a standard page that asks for the identifier before presenting the page.

== Tabled Data ==

When viewing tabled data the frontend pulls the tableId's config from backend, then when requesting the data also requests the serviceTag > objectType schema for use when displaying the data.

== Code Standardization ==

Code such as middleware validation schema and saving data to databases can be standardized.

== Code Generation ==

Endpoints per object for actions such as Create/Delete/Update can be automatically generated from objectSchema.

=== Code Generation Structure ===

* npm for generic code generation, can be used in any project, includes functions for generating Source files from templates and developer files
* npm for per project specific files, eg templates for the project (Create/Update/.. code)
* Empty Service Template has GenerateCode.js script file in root dir that is run to generate code, it invokes a generation function from generic npm with param that points to per project npm's templates
* generated Source retains hook tags (and any developer added code), so if developer wants to update developer's file with updated template code they can generate code and simply copy generated Source to src folder

= Graph Server Config =

* S3 has a list of graphServerTag's linking to the GraphHandler serviceTag responsible for the graph
* multiple graphServerTags can point to one GraphHandler, combining graphs into one server
* when creating each GraphHandler's graph schemas, for each field split out the fields into each GraphHandler using the graphServerTag, if multiple graphServerTags for a field point to the same GraphHandler combine the fields to create GraphHandler's graph schema
* every GraphHandler an object is saved into will require it's identifiers
* when eg updating fields for an object separate the fields per GraphHandler before sending the request to update each graph

= Extended Object Types =

* Allows for one graph node to have multiple labels
* graph schema is created for both the core object and the extended object
* eg Media Manager's has a node schema for "media" object type, and Image service has a node schema for "image" object type
* the extended object builds it's schema by combining core + extended settings

= Working documents =

[[:Category:Working_documents - Per Service Schemas|Per Service Schemas]]

Per Service Schemas

2026-08-19T07:11:54Z

Seagame:

= Overview =

Each service manages a schema of object/resources that it is responsible for, this schema is available to other services and frontends. The schema includes a list of fields available for each object.

= File Structure =

* see [[Repository structure#schemas|Repository structure]]

= ObjectSchema | ObjectFieldSchema.js =

== Not extendObjType ==

<syntaxhighlight lang="javascript">
{
objectType: "xx",
shortNameObjectType:"x", // optional, use when generate code create lambda role with long name
canDelete: false, // whether any fields can be deleted // default = false
belongTo: {
serviceTag:"iii",
objectType:"jjj"
},
// how is the object created
// userGenerated there will be generated endpoints for api or sqs (used in importBatchMain) to create object
// systemGenerated must be created by flow/s
// searchResultGenerated see separate notes below
generatedBy: "userGenerated" || "systemGenerated" || "systemNoUserId" || "systemWithUserId" || "searchResultGenerated" // required
searchResultGeneratedFlowType: {}, // for generatedBy = searchResultGenerated
addOnDataStructure: [ // optional, add for additional setting to objectType
{
// all fields that a user can edit must be in versionedData, and all fields in versionedData must be editable by user
type:"versionedData",
versionedDataLabel: "xx", // versionedData label name
storageResourceTag : "xx", // ref to storegeResourceTag
fieldNames: { // fieldName in versionedData cannot have in in main objectSchema.fieldNames
"aaa":{ // fieldName
type: "xx", // string|integer|number|timestamp|currency|currencyValue|float|special|object|boolean|arrayMixed|arrayNumeric|arrayString
requiredOnCreate: false, // default = false
optionalOnCreate: false, // default = false,
validation: {
itemValidation:{} // for validate item in array
},
// probably impossible to have fromObjType, because data can be changed by user here
fromObjType:{
serviceTag: "xxx",
objectType: "xxx"
},
},
// ...
}
},
{ // can have multiple addOn of type attributeTree
type:"attributeTree",
},
{
type:"translation"
},
{
type:"propertyValue"
},
{
type:"mediaLink"
},
{
type:"rbac"
},
// ...
],
plugInTags: ["a", "b"], // plugIns that can be connected to this objType
storageResources:{
"xxx":{ // storageResourceTag
storageType: "xx", // graph
graphServerTag: "xx", // setting for storageType graph
additionalGraphIndexes:[['fieldName1', 'fieldName2', ...], [...]] // will make graph index with specific fieldName
},
"zzz":{ // storageResourceTag
storageType: "xx", // dynamoDB
// setting for storageType dynamoDB
tableName: "xx",
groupByPartitionKeyField: "xx", // use groupByPartitionKeyField as partition key and not have sort key in dynamoDB, if have multiple identifiers will concat it. And use it as partitionKey.
serviceTag:"zz"// default own service.
}
},
fieldNames: {
xxx: { // fieldName
type: "xx", // string|integer|number|timestamp|currency|currencyValue|float|special|object|boolean|arrayMixed|arrayNumeric|arrayString
randomOnCreate: false, // default = false , can set true in fieldName that part of identifiers and identifiers have single identifierFieldname
requiredOnCreate: false, // default = false
optionalOnCreate: false, // default = false
canUpdate: true, // default = true (only system/flows can edit, no history of changes unless flow manually adds)
validation: {
itemValidation:{} // for validate item in array
}, // maybe ajv syntax
storageResourceTags: ["xx","yy"], // reference to storageResources property
fromObjType:{
serviceTag: "xxx",
objectType: "xxx"
},
hashOnCreate: ["xx", "yy"], // reference to other fieldName,
statusField: true, // use for objectSchema inside flowSchema, identify which field is statusField

// comes from requiredOnCreate relationships
fromRequiredOnCreate: {
relType: {
serviceTag:"aa",
relationshipTag:"bb"
},
// or
belongToObjType: true, // if set to true use the belongTo relationship to belongTo objType

fieldName:"" // optional default= same field name eg: now default == xxx if not defined(use fieldname of object inside link when create)
}
},
// ...
},
compositeKeyDeliminator: "xx", // join partitionKey and sortKey
identifiers: [
// for dynamoDB storageType
{
type: "partitionKey",

fieldNames: ["xx","yy"], // composite partition keys in DynamoDB
deliminator: "xx", // optional, defaults to "_"
name: "zz", // name of field in database
// or
fieldName: "xx"

},
{
type: "sortKey",

fieldNames: ["xx","yy"], // composite partition keys in DynamoDB
deliminator: "xx", // optional, defaults to "_"
name: "zz", // name of field in database
// or
fieldName: "xx"

},

// for graph storageType
{
type: "identifier",
fieldNames: ["xx","yy"], // identifier field in graph or composite partition keys in DynamoDB
name: "zzz" // use when save in dynamoDB partitionKey
deliminator: "xx", // optional, defaults to "_"
// or
fieldName: "xx"
},
]
}
</syntaxhighlight>

== extendObjType ==

<syntaxhighlight lang="javascript">
{
// for objects stored in graph this will add another node label
objectType: "xx", // new label to add
extendObjType: { // core object that this object extends
serviceTag: "xxx",
objectType: "xxx"
},
addOnDataStructure: [],
storageResources:{ // these are the storageResources that carry the extended objects settings,
// (see above)
},
fieldNames: {
// (see above)
},
// canDelete/identifiers come from the core object
}
</syntaxhighlight>

== searchResultGenerated ==

* must be created by flow
* eg: variantProduct
* not have any storageResources
* identifiers are automatically searchResultData identifiers
* a searchResult request for this object will enter the searchResultGeneratedFlowType flow which creates searchResultData that can then be queried/sorted
* all relationships must be storageType = lambda, eg translate from variantProduct to variant uses a translateId flow to query the variantProduct identifier (searchResultData) to find the variantId in it's requiredData results
* searchResultGeneratedFlowType takes over after creating searchResultMain record until processRequiredData
* if objectSchema defines any fieldnames, then they are found using a flow, maybe as hooks in per service findData
* when finding direct fieldname, will need to check if requireData already exists, if not enter flow/findData to create
* no fields can be edited, so can show in forms but no updates performed

= Relationships Schema | ObjectRelationships.js =

* stored in top level schemas folder
* parent/child determines relationship direction for graph relationships
* have one service that contains information of each relationship

<syntaxhighlight lang="javascript">
// relationship schema in responsible service
[
{
"xxx": { // relationshipTag - name of relationship type stored in graph
generatedBy: "userGenerated" || "systemGenerated" || "systemNoUserId" || "systemWithUserId" // default="userGenerated"
canChangeToRelTypes: [
{
relType: { // relType that this relType can change to
serviceTag:"xxx",
relationshipTag: "yyy"
},
changeBy: "user" // "systemNoUserId" | "systemWithUserId" | "user", default="user"
}
// another relType
],
storageResources:{
"xxx":{ // storageResourceTag
storageType: "xx", // dynamoDB | graph | lambda
// if storageType="dynamoDB" will not specify tableName in relationship schema

// setting for storageType graph
graphServerTag: "xx",
additionalGraphIndexes:[['fieldName1', 'fieldName2', ...], [...]], // will make graph index with specific fieldName

// setting for storageType lambda
serviceTag: "xx",
functionName: "xx",
}
},
fieldNames: {
"xxx": { // relationship property name
type: "string", // "string" | "number" ...
requiredOnCreate: false, // default=false
optionalOnCreate: false, // default = false
updateBy: "user" // "systemNoUserId" | "systemWithUserId" | "user" | "none", default="user"
validation: {} // ajv syntax
},
//...other relationship properties
},
links: [
{
storageResourceTags: ["xxx"], // reference from storageResources property
canDelete: false // default = false, if set true will allow delete relationship between 2 objType
from: {
objType: {
serviceTag: "xx",
objectType: "xx"
},
requiredOnCreate: true, // if set true will create relationshipTag when create objType data, if both "from" and "to" linkType="many" should not have requiredOnCreate, exists in "from" or "to" only
linkType: "", // one | many
// moveBy: "none", // "systemNoUserId" | "systemWithUserId" | "user" | "none", default="none"
// belongTo:true
},
to: {
objType: {
serviceTag: "yy",
objectType: "yy"
},
linkType: "", // one | many
// moveBy allows the relationship to be moved between 2 instances of the same objType only
moveBy: "none", // "systemNoUserId" | "systemWithUserId" | "user" | "none", default="none"
belongTo:true, // false
},
requestProperties: {
// if storageType is Lambda and translateIds/linkPath requires properties set them here (eg sellOffer>orderPrice)
tag_deliverTo: {
requestPropertyType: "objectIdentifier",
objType: {
serviceTag: "Locations",
objectType: "locationNode" // deliversToLocationNode
},
identifiersFieldName: "locationNodeId"
},
// ... other request properties
}
}
// ...other link
]
}
}
]

</syntaxhighlight>

= Reference Relationships Schema | RefObjectRelationships.js =

<syntaxhighlight lang="javascript">
// reference to relationshipTag in external service
[
{
objectType: "zz", // objectType in local service
relationshipTag: "xxx", // name of relationshiptag of objType
relationshipServiceTag: "xx" // point to service tag that contain data of relationshipTag of objType
}
]

</syntaxhighlight>

= Flow Schema | FlowSchemas.js =

<syntaxhighlight lang="javascript">
[
{
flowTag: "yyy",
initiateBy: "user", // "user" | "system" -- if receive plugin should be user
handleObj: "one", // "one" | "multi"
statusType: "statusField", // "statusField" | "storedCache" | "none" | "triggerCache"

// statusType="triggerCache" setting
triggerType: "storedCache", // "storedCache" | "switch"
triggerFlowTypes: [
//... triggerFlowType
],

// statusType="statusField" | "triggerCache" | "storedCache" setting:
objType: {},

event: ["ownTopic"], // "ownTopic" | "extTopic" | "s3" | "eventBridge" | "lambdaSyncInv" | "lambdaSyncApi" | "generatedCode" | "dsq"

// event="s3" setting
bucketName: "xxx", // bucket for s3 event
createBucket: boolean, // if true will generate new bucket with bucketName if false will point to old bucket that already have

// event="eventBridge" setting
schedules: [
{
name: 'your-scheduled-rate-event-name',
description: 'your scheduled rate event description',
rate: ["rate(1 minute)",],
input: {}
}
],

outputTopic: boolean,

flowSteps: {
inTag: { // will generate Topic serviceTag_stage_yyy_inTag
properties: [], // reference to stepProperties key, the first lambda's input properties and messageAttributes are the flow's input properties and messageAttributes
messageAttributes: [], // reference to stepProperties key
plugInHooks: [
{
plugInHookTag: "",
objType: {}, // used to query connection dynamo for an object instance in current flow
},
],
returnValues: {
properties: [], // reference to stepProperties key
messageAttributes: [], // reference to stepProperties key, only for outputTopic=true
},

},
// another flow steps
flowStep1: { // will generate Topic serviceTag_stage_yyy_Flow1
properties: [], // reference to stepProperties key
messageAttributes: [], // reference to stepProperties key
event: ["ownTopic"], // "ownTopic" | "extTopic" | "s3" | "eventBridge" | "lambdaSyncInv" | "lambdaSyncApi" | "generatedCode" | "dsq"
// handle splitting logic into awaitingStep/awaitingMultipleSteps
// handle splitting logic into paginated lambda

previousSteps: [
{
sourceType:"ownTopic", // if from own flow
stepName: "xxx",
},
{
sourceType: "extTopic", // triggered by output from external service
serviceTag: "InventoryService",
topic: "ReserveStock_In",
fromStepNames: ["xx"] // which step in this flow sent request to external flow, used to find awaitingStep prefix
}
],
nextSteps: [
{
targetType:"ownTopic", // if from own flow
stepName: "yyy"
},
{
targetType: "extTopic",
serviceTag: "InventoryService",
topic: "ReserveStock_In",
toStepNames: ["xx"] // which step in this flow sent request to external flow, used to find awaitingStep prefix
}
],

plugInHooks: [
{
plugInHookTag: "",
objType: {}, // used to query connection dynamo for an object instance in current flow
},
],
returnValues: { // the last lambda function returnValues are the flow's returnValues
properties: [], // reference to stepProperties key
messageAttributes: [], // reference to stepProperties key, only for outputTopic=true
},

},
},

stepProperties: { // normalized all stepProperties
"uuid": {
propertyName: "xxx",
type: "object",
required: false, // true | false default=false
childProperties: ["uuid2", "uuid3"]
},
"uuid2": {
propertyName: "xxx",
required: false, // true | false default=false
type: "string",
},
"uuid3": {
propertyName: "xxx",
required: false, // true | false default=false
type: "string",
},
"uuid4": {
required: false, // true | false default=false
objectField: {
objType: {},
fieldName: "xx"
},
overwritePropertyName: "xx" // optional, if have objectField and have overwritePropertyName will overwrite fieldName
}
},
stepMessageAttributes: { // normalized all stepMessageAttributes
"uuid": {
propertyName: "xxx",
required: false, // true | false default=false
type: "string",
},
"uuid2": {
propertyName: "yyy",
required: false, // true | false default=false
type: "string",
}
},
}
]
</syntaxhighlight>

= System Text Schema | SystemTextSchemas.js =

<syntaxhighlight lang="javascript">
[
{
namespace: "xxx", // groups files downloaded by frontend
systemTextTag: "yyy",
}
]
</syntaxhighlight>

== Auto generated systemText and namespaces ==

=== systemNotification names ===

* namespace: "sysNotification_{notificationGrouping}"
* systemTextTag: "{notificationTag}"
* eg shown on notification settings page

=== objType names ===

* namespace: "objTypes"
* systemTextTag: "{serviceTag}_{objectType}"
* eg shown on config pages, eg pulldown list of object types

=== objType field name descriptions ===

* namespace: "objType_fielddesc_{serviceTag}_{objectType}"
* systemTextTag: "{fieldname}"
* eg shown on config pages, eg info box for each field name

= System Notification Schema | SystemNotificationSchemas.js =

<syntaxhighlight lang="javascript">
[
{
notificationTag: "xxx",
notificationGrouping: "yyy",
weight: "##",
},
]
</syntaxhighlight>

= Generated S3 files =

* generate multiple files for different uses, eg:
*# list of saved fieldNames for Create
*# list of saved+calculated for Update/Info pages
*# graphSchemas
*# relationships (used by Search/Sort Results)

= Use Cases =

== Find Deployed Service Name ==

* other services can use fixed serviceTag to get deployed serviceName from serviceSchema on S3
* used to build resource names for external services
* eg when one service needs to send a message into an SNS belonging to a different service

== Standard Create, Update, List, Delete pages ==

* List and Delete are maybe not required, use table data system instead.
* object schema can add validation information that can be used on the frontend to check before sending to backend, and by the backend to validate the data before handling

=== Create Object ===

* can configure what fields are shown
* requiredOnCreate fields must be shown

=== Edit Object ===

* users setup any number of pages for object types with configurable fields shown
* fields can be either display only or edit
* each field can adjust it's display properties (perhaps via cssStyles)

== Menu Config ==

When adding menu items can add links to create, update, list, delete objects, user chooses the service then from that service's list of objects and what action is being performed. For update/delete perhaps links to a standard page that asks for the identifier before presenting the page.

== Tabled Data ==

When viewing tabled data the frontend pulls the tableId's config from backend, then when requesting the data also requests the serviceTag > objectType schema for use when displaying the data.

== Code Standardization ==

Code such as middleware validation schema and saving data to databases can be standardized.

== Code Generation ==

Endpoints per object for actions such as Create/Delete/Update can be automatically generated from objectSchema.

=== Code Generation Structure ===

* npm for generic code generation, can be used in any project, includes functions for generating Source files from templates and developer files
* npm for per project specific files, eg templates for the project (Create/Update/.. code)
* Empty Service Template has GenerateCode.js script file in root dir that is run to generate code, it invokes a generation function from generic npm with param that points to per project npm's templates
* generated Source retains hook tags (and any developer added code), so if developer wants to update developer's file with updated template code they can generate code and simply copy generated Source to src folder

= Graph Server Config =

* S3 has a list of graphServerTag's linking to the GraphHandler serviceTag responsible for the graph
* multiple graphServerTags can point to one GraphHandler, combining graphs into one server
* when creating each GraphHandler's graph schemas, for each field split out the fields into each GraphHandler using the graphServerTag, if multiple graphServerTags for a field point to the same GraphHandler combine the fields to create GraphHandler's graph schema
* every GraphHandler an object is saved into will require it's identifiers
* when eg updating fields for an object separate the fields per GraphHandler before sending the request to update each graph

= Extended Object Types =

* Allows for one graph node to have multiple labels
* graph schema is created for both the core object and the extended object
* eg Media Manager's has a node schema for "media" object type, and Image service has a node schema for "image" object type
* the extended object builds it's schema by combining core + extended settings

= Working documents =

[[:Category:Working_documents - Per Service Schemas|Per Service Schemas]]

2026-08-18 - Backend User and RBAC Data

2026-08-19T02:23:57Z

Seagame: /* updated idea */

[[User Data Handling]]

= Overview =

How to pass around userId and targetIdentifiers for permissions/account limits/resource use, and for creating automatic data such as createdBy and belongTo relationships in graph database.

= updated idea =

* baseUserId can stay in _izContext because it should not change during processing
* maybe change baseUserId to submittedByUserId to be more clear, but see baseUserId reason for name below
* however consider if future flows will handle many submittedByUserIds, eg automated tasks that handle many submitted tasks, if that is common it might be better to allow generated code to pass the submittedByUserId as a flow input param
* targetId change to identifer object {fieldname: fieldValue} named targetIdentifiers
* generated code can where possible add this automatically when initializing flows, and can check received valid identifiers according to flowSchema

== RBAC ==

* RBAC actions are basically list of flows, with target coming from the flows base objType (using either that objTypes rbac additional addOnDataStructure or if that objType has belongTo following that)
* generated code automatically validates submittedByUserId and targetIdentifiers, sends to permissionHandler/RBAC

== Account Limits ==

* standardize checking of accountLimits so generated code can check per flow
* probably allow for additional developer added accountLimits to be checked anywhere in code

== Resource use ==

* ? connected to target user if belongTo = user, but if not connect to submittedByUserId

= old attempts =

== First design ==

* url paths sent from frontend had the service/resource/action and targetId in the url path, extracted by API Gateway
* submittedBy userId was extracted/confirmed from the Cognito token/sub
* RBAC was handled by a Lambda authorizer that used the above extracted variables
* submittedBy and targetIds were saved into iz_Context and automatically passed to proceeding logic

=== limitations ===

* requests must pass API Gateway to extract values
* Lambda authorizers can have limitations that complicated processing

== Second design ==

* using schemas and generated code
* RBAC moved out of authorizers and implemented inside handler lambdas
* still in _izContext
* variable name is baseUserId, because accountLimits/resourceUse are connected to target userId if belong to User, but baseUserId if not

=== limitations ===

* targetId is a concat string for composite identifiers, want all handling of identifiers to be an object, only change to concat when required (eg save to database that requires single string)
* some flows might need to adjust target according to steps, eg importBatch submission belongTo user but each pending element may have different belongTo objType/instances, this complicates targetId management in _izContext

[[Category:Working_documents - User Data Handling| 2026-08-18]]
[[Category:Working documents| 2026-08-18]]

2026-08-18 - Backend User and RBAC Data

2026-08-19T02:23:42Z

Seagame: /* Second design */

[[User Data Handling]]

= Overview =

How to pass around userId and targetIdentifiers for permissions/account limits/resource use, and for creating automatic data such as createdBy and belongTo relationships in graph database.

= updated idea =

* baseUserId can stay in iz_Context because it should not change during processing
* maybe change baseUserId to submittedByUserId to be more clear, but see baseUserId reason for name below
* however consider if future flows will handle many submittedByUserIds, eg automated tasks that handle many submitted tasks, if that is common it might be better to allow generated code to pass the submittedByUserId as a flow input param
* targetId change to identifer object {fieldname: fieldValue} named targetIdentifiers
* generated code can where possible add this automatically when initializing flows, and can check received valid identifiers according to flowSchema

== RBAC ==

* RBAC actions are basically list of flows, with target coming from the flows base objType (using either that objTypes rbac additional addOnDataStructure or if that objType has belongTo following that)
* generated code automatically validates submittedByUserId and targetIdentifiers, sends to permissionHandler/RBAC

== Account Limits ==

* standardize checking of accountLimits so generated code can check per flow
* probably allow for additional developer added accountLimits to be checked anywhere in code

== Resource use ==

* ? connected to target user if belongTo = user, but if not connect to submittedByUserId

= old attempts =

== First design ==

* url paths sent from frontend had the service/resource/action and targetId in the url path, extracted by API Gateway
* submittedBy userId was extracted/confirmed from the Cognito token/sub
* RBAC was handled by a Lambda authorizer that used the above extracted variables
* submittedBy and targetIds were saved into iz_Context and automatically passed to proceeding logic

=== limitations ===

* requests must pass API Gateway to extract values
* Lambda authorizers can have limitations that complicated processing

== Second design ==

* using schemas and generated code
* RBAC moved out of authorizers and implemented inside handler lambdas
* still in _izContext
* variable name is baseUserId, because accountLimits/resourceUse are connected to target userId if belong to User, but baseUserId if not

=== limitations ===

* targetId is a concat string for composite identifiers, want all handling of identifiers to be an object, only change to concat when required (eg save to database that requires single string)
* some flows might need to adjust target according to steps, eg importBatch submission belongTo user but each pending element may have different belongTo objType/instances, this complicates targetId management in _izContext

[[Category:Working_documents - User Data Handling| 2026-08-18]]
[[Category:Working documents| 2026-08-18]]

Per Service Schemas

2026-08-12T02:28:51Z

Seagame: /* Flow Schema | FlowSchemas.js */

= Overview =

Each service manages a schema of object/resources that it is responsible for, this schema is available to other services and frontends. The schema includes a list of fields available for each object.

= File Structure =

* see [[Repository structure#schemas|Repository structure]]

= ObjectSchema | ObjectFieldSchema.js =

== Not extendObjType ==

<syntaxhighlight lang="javascript">
{
objectType: "xx",
shortNameObjectType:"x", // optional, use when generate code create lambda role with long name
canDelete: false, // whether any fields can be deleted // default = false
belongTo: {
serviceTag:"iii",
objectType:"jjj"
},
// how is the object created
// userGenerated there will be generated endpoints for api or sqs (used in importBatchMain) to create object
// systemGenerated must be created by flow/s
// searchResultGenerated see separate notes below
generatedBy: "userGenerated" || "systemGenerated" || "searchResultGenerated" // required
searchResultGeneratedFlowType: {}, // for generatedBy = searchResultGenerated
addOnDataStructure: [ // optional, add for additional setting to objectType
{
// all fields that a user can edit must be in versionedData, and all fields in versionedData must be editable by user
type:"versionedData",
versionedDataLabel: "xx", // versionedData label name
storageResourceTag : "xx", // ref to storegeResourceTag
fieldNames: { // fieldName in versionedData cannot have in in main objectSchema.fieldNames
"aaa":{ // fieldName
type: "xx", // string|integer|number|timestamp|currency|currencyValue|float|special|object|boolean|arrayMixed|arrayNumeric|arrayString
requiredOnCreate: false, // default = false
optionalOnCreate: false, // default = false,
validation: {
itemValidation:{} // for validate item in array
},
// probably impossible to have fromObjType, because data can be changed by user here
fromObjType:{
serviceTag: "xxx",
objectType: "xxx"
},
},
// ...
}
},
{ // can have multiple addOn of type attributeTree
type:"attributeTree",
},
{
type:"translation"
},
{
type:"propertyValue"
},
{
type:"mediaLink"
},
{
type:"rbac"
},
// ...
],
plugInTags: ["a", "b"], // plugIns that can be connected to this objType
storageResources:{
"xxx":{ // storageResourceTag
storageType: "xx", // graph
graphServerTag: "xx", // setting for storageType graph
additionalGraphIndexes:[['fieldName1', 'fieldName2', ...], [...]] // will make graph index with specific fieldName
},
"zzz":{ // storageResourceTag
storageType: "xx", // dynamoDB
// setting for storageType dynamoDB
tableName: "xx",
groupByPartitionKeyField: "xx", // use groupByPartitionKeyField as partition key and not have sort key in dynamoDB, if have multiple identifiers will concat it. And use it as partitionKey.
serviceTag:"zz"// default own service.
}
},
fieldNames: {
xxx: { // fieldName
type: "xx", // string|integer|number|timestamp|currency|currencyValue|float|special|object|boolean|arrayMixed|arrayNumeric|arrayString
randomOnCreate: false, // default = false , can set true in fieldName that part of identifiers and identifiers have single identifierFieldname
requiredOnCreate: false, // default = false
optionalOnCreate: false, // default = false
canUpdate: true, // default = true (only system/flows can edit, no history of changes unless flow manually adds)
validation: {
itemValidation:{} // for validate item in array
}, // maybe ajv syntax
storageResourceTags: ["xx","yy"], // reference to storageResources property
fromObjType:{
serviceTag: "xxx",
objectType: "xxx"
},
hashOnCreate: ["xx", "yy"], // reference to other fieldName,
statusField: true, // use for objectSchema inside flowSchema, identify which field is statusField

// comes from requiredOnCreate relationships
fromRequiredOnCreate: {
relType: {
serviceTag:"aa",
relationshipTag:"bb"
},
// or
belongToObjType: true, // if set to true use the belongTo relationship to belongTo objType

fieldName:"" // optional default= same field name eg: now default == xxx if not defined(use fieldname of object inside link when create)
}
},
// ...
},
compositeKeyDeliminator: "xx", // join partitionKey and sortKey
identifiers: [
// for dynamoDB storageType
{
type: "partitionKey",

fieldNames: ["xx","yy"], // composite partition keys in DynamoDB
deliminator: "xx", // optional, defaults to "_"
name: "zz", // name of field in database
// or
fieldName: "xx"

},
{
type: "sortKey",

fieldNames: ["xx","yy"], // composite partition keys in DynamoDB
deliminator: "xx", // optional, defaults to "_"
name: "zz", // name of field in database
// or
fieldName: "xx"

},

// for graph storageType
{
type: "identifier",
fieldNames: ["xx","yy"], // identifier field in graph or composite partition keys in DynamoDB
name: "zzz" // use when save in dynamoDB partitionKey
deliminator: "xx", // optional, defaults to "_"
// or
fieldName: "xx"
},
]
}
</syntaxhighlight>

== extendObjType ==

<syntaxhighlight lang="javascript">
{
// for objects stored in graph this will add another node label
objectType: "xx", // new label to add
extendObjType: { // core object that this object extends
serviceTag: "xxx",
objectType: "xxx"
},
addOnDataStructure: [],
storageResources:{ // these are the storageResources that carry the extended objects settings,
// (see above)
},
fieldNames: {
// (see above)
},
// canDelete/identifiers come from the core object
}
</syntaxhighlight>

== searchResultGenerated ==

* must be created by flow
* eg: variantProduct
* not have any storageResources
* identifiers are automatically searchResultData identifiers
* a searchResult request for this object will enter the searchResultGeneratedFlowType flow which creates searchResultData that can then be queried/sorted
* all relationships must be storageType = lambda, eg translate from variantProduct to variant uses a translateId flow to query the variantProduct identifier (searchResultData) to find the variantId in it's requiredData results
* searchResultGeneratedFlowType takes over after creating searchResultMain record until processRequiredData
* if objectSchema defines any fieldnames, then they are found using a flow, maybe as hooks in per service findData
* when finding direct fieldname, will need to check if requireData already exists, if not enter flow/findData to create
* no fields can be edited, so can show in forms but no updates performed

= Relationships Schema | ObjectRelationships.js =

* stored in top level schemas folder
* parent/child determines relationship direction for graph relationships
* have one service that contains information of each relationship

<syntaxhighlight lang="javascript">
// relationship schema in responsible service
[
{
"xxx": { // relationshipTag - name of relationship type stored in graph
generatedBy: "userGenerated" || "systemGenerated" // default="userGenerated"
canChangeToRelTypes: [
{
relType: { // relType that this relType can change to
serviceTag:"xxx",
relationshipTag: "yyy"
},
changeBy: "user" // "systemNoUserId" | "systemWithUserId" | "user", default="user"
}
// another relType
],
storageResources:{
"xxx":{ // storageResourceTag
storageType: "xx", // dynamoDB | graph | lambda
// if storageType="dynamoDB" will not specify tableName in relationship schema

// setting for storageType graph
graphServerTag: "xx",
additionalGraphIndexes:[['fieldName1', 'fieldName2', ...], [...]], // will make graph index with specific fieldName

// setting for storageType lambda
serviceTag: "xx",
functionName: "xx",
}
},
fieldNames: {
"xxx": { // relationship property name
type: "string", // "string" | "number" ...
requiredOnCreate: false, // default=false
optionalOnCreate: false, // default = false
updateBy: "user" // "systemNoUserId" | "systemWithUserId" | "user" | "none", default="user"
validation: {} // ajv syntax
},
//...other relationship properties
},
links: [
{
storageResourceTags: ["xxx"], // reference from storageResources property
canDelete: false // default = false, if set true will allow delete relationship between 2 objType
from: {
objType: {
serviceTag: "xx",
objectType: "xx"
},
requiredOnCreate: true, // if set true will create relationshipTag when create objType data, if both "from" and "to" linkType="many" should not have requiredOnCreate, exists in "from" or "to" only
linkType: "", // one | many
// moveBy: "none", // "systemNoUserId" | "systemWithUserId" | "user" | "none", default="none"
// belongTo:true
},
to: {
objType: {
serviceTag: "yy",
objectType: "yy"
},
linkType: "", // one | many
// moveBy allows the relationship to be moved between 2 instances of the same objType only
moveBy: "none", // "systemNoUserId" | "systemWithUserId" | "user" | "none", default="none"
belongTo:true, // false
},
requestProperties: {
// if storageType is Lambda and translateIds/linkPath requires properties set them here (eg sellOffer>orderPrice)
tag_deliverTo: {
requestPropertyType: "objectIdentifier",
objType: {
serviceTag: "Locations",
objectType: "locationNode" // deliversToLocationNode
},
identifiersFieldName: "locationNodeId"
},
// ... other request properties
}
}
// ...other link
]
}
}
]

</syntaxhighlight>

= Reference Relationships Schema | RefObjectRelationships.js =

<syntaxhighlight lang="javascript">
// reference to relationshipTag in external service
[
{
objectType: "zz", // objectType in local service
relationshipTag: "xxx", // name of relationshiptag of objType
relationshipServiceTag: "xx" // point to service tag that contain data of relationshipTag of objType
}
]

</syntaxhighlight>

= Flow Schema | FlowSchemas.js =

<syntaxhighlight lang="javascript">
[
{
flowTag: "yyy",
initiateBy: "user", // "user" | "system" -- if receive plugin should be user
handleObj: "one", // "one" | "multi"
statusType: "statusField", // "statusField" | "storedCache" | "none" | "triggerCache"

// statusType="triggerCache" setting
triggerType: "storedCache", // "storedCache" | "switch"
triggerFlowTypes: [
//... triggerFlowType
],

// statusType="statusField" | "triggerCache" | "storedCache" setting:
objType: {},

event: ["ownTopic"], // "ownTopic" | "extTopic" | "s3" | "eventBridge" | "lambdaSyncInv" | "lambdaSyncApi" | "generatedCode" | "dsq"

// event="s3" setting
bucketName: "xxx", // bucket for s3 event
createBucket: boolean, // if true will generate new bucket with bucketName if false will point to old bucket that already have

// event="eventBridge" setting
schedules: [
{
name: 'your-scheduled-rate-event-name',
description: 'your scheduled rate event description',
rate: ["rate(1 minute)",],
input: {}
}
],

// event="generatedCode" setting
generatedCodeConfig: {
generatedCodeTag: "create", // tag for generated code, eg "create" | "update" | "delete"
codeHookTag: "xx", // which codeHook to initiate flow from
// maybe validate: invocationType must exist in "event" array, so don't need to check 2 places when eg creating sns topic
invocationType: "ownTopic", // "ownTopic" | "lambdaSyncInv"

objType: {}, // which cases in the generated code trigger the flow
// .. other settings depending on generated code
},

outputTopic: boolean,

flowSteps: {
inTag: { // will generate Topic serviceTag_stage_yyy_inTag
properties: [], // reference to stepProperties key, the first lambda's input properties and messageAttributes are the flow's input properties and messageAttributes
messageAttributes: [], // reference to stepProperties key
plugInHooks: [
{
plugInHookTag: "",
objType: {}, // used to query connection dynamo for an object instance in current flow
},
],
returnValues: {
properties: [], // reference to stepProperties key
messageAttributes: [], // reference to stepProperties key, only for outputTopic=true
},

},
// another flow steps
flowStep1: { // will generate Topic serviceTag_stage_yyy_Flow1
properties: [], // reference to stepProperties key
messageAttributes: [], // reference to stepProperties key
event: ["ownTopic"], // "ownTopic" | "extTopic" | "s3" | "eventBridge" | "lambdaSyncInv" | "lambdaSyncApi" | "generatedCode" | "dsq"
// handle splitting logic into awaitingStep/awaitingMultipleSteps
// handle splitting logic into paginated lambda

previousSteps: [
{
sourceType:"ownTopic", // if from own flow
stepName: "xxx",
},
{
sourceType: "extTopic", // triggered by output from external service
serviceTag: "InventoryService",
topic: "ReserveStock_In",
fromStepNames: ["xx"] // which step in this flow sent request to external flow, used to find awaitingStep prefix
}
],
nextSteps: [
{
targetType:"ownTopic", // if from own flow
stepName: "yyy"
},
{
targetType: "extTopic",
serviceTag: "InventoryService",
topic: "ReserveStock_In",
toStepNames: ["xx"] // which step in this flow sent request to external flow, used to find awaitingStep prefix
}
],

plugInHooks: [
{
plugInHookTag: "",
objType: {}, // used to query connection dynamo for an object instance in current flow
},
],
returnValues: { // the last lambda function returnValues are the flow's returnValues
properties: [], // reference to stepProperties key
messageAttributes: [], // reference to stepProperties key, only for outputTopic=true
},

},
},

stepProperties: { // normalized all stepProperties
"uuid": {
propertyName: "xxx",
type: "object",
required: false, // true | false default=false
childProperties: ["uuid2", "uuid3"]
},
"uuid2": {
propertyName: "xxx",
required: false, // true | false default=false
type: "string",
},
"uuid3": {
propertyName: "xxx",
required: false, // true | false default=false
type: "string",
},
"uuid4": {
required: false, // true | false default=false
objectField: {
objType: {},
fieldName: "xx"
},
overwritePropertyName: "xx" // optional, if have objectField and have overwritePropertyName will overwrite fieldName
}
},
stepMessageAttributes: { // normalized all stepMessageAttributes
"uuid": {
propertyName: "xxx",
required: false, // true | false default=false
type: "string",
},
"uuid2": {
propertyName: "yyy",
required: false, // true | false default=false
type: "string",
}
},
}
]
</syntaxhighlight>

= System Text Schema | SystemTextSchemas.js =

<syntaxhighlight lang="javascript">
[
{
namespace: "xxx", // groups files downloaded by frontend
systemTextTag: "yyy",
}
]
</syntaxhighlight>

== Auto generated systemText and namespaces ==

=== systemNotification names ===

* namespace: "sysNotification_{notificationGrouping}"
* systemTextTag: "{notificationTag}"
* eg shown on notification settings page

=== objType names ===

* namespace: "objTypes"
* systemTextTag: "{serviceTag}_{objectType}"
* eg shown on config pages, eg pulldown list of object types

=== objType field name descriptions ===

* namespace: "objType_fielddesc_{serviceTag}_{objectType}"
* systemTextTag: "{fieldname}"
* eg shown on config pages, eg info box for each field name

= System Notification Schema | SystemNotificationSchemas.js =

<syntaxhighlight lang="javascript">
[
{
notificationTag: "xxx",
notificationGrouping: "yyy",
weight: "##",
},
]
</syntaxhighlight>

= Generated S3 files =

* generate multiple files for different uses, eg:
*# list of saved fieldNames for Create
*# list of saved+calculated for Update/Info pages
*# graphSchemas
*# relationships (used by Search/Sort Results)

= Use Cases =

== Find Deployed Service Name ==

* other services can use fixed serviceTag to get deployed serviceName from serviceSchema on S3
* used to build resource names for external services
* eg when one service needs to send a message into an SNS belonging to a different service

== Standard Create, Update, List, Delete pages ==

* List and Delete are maybe not required, use table data system instead.
* object schema can add validation information that can be used on the frontend to check before sending to backend, and by the backend to validate the data before handling

=== Create Object ===

* can configure what fields are shown
* requiredOnCreate fields must be shown

=== Edit Object ===

* users setup any number of pages for object types with configurable fields shown
* fields can be either display only or edit
* each field can adjust it's display properties (perhaps via cssStyles)

== Menu Config ==

When adding menu items can add links to create, update, list, delete objects, user chooses the service then from that service's list of objects and what action is being performed. For update/delete perhaps links to a standard page that asks for the identifier before presenting the page.

== Tabled Data ==

When viewing tabled data the frontend pulls the tableId's config from backend, then when requesting the data also requests the serviceTag > objectType schema for use when displaying the data.

== Code Standardization ==

Code such as middleware validation schema and saving data to databases can be standardized.

== Code Generation ==

Endpoints per object for actions such as Create/Delete/Update can be automatically generated from objectSchema.

=== Code Generation Structure ===

* npm for generic code generation, can be used in any project, includes functions for generating Source files from templates and developer files
* npm for per project specific files, eg templates for the project (Create/Update/.. code)
* Empty Service Template has GenerateCode.js script file in root dir that is run to generate code, it invokes a generation function from generic npm with param that points to per project npm's templates
* generated Source retains hook tags (and any developer added code), so if developer wants to update developer's file with updated template code they can generate code and simply copy generated Source to src folder

= Graph Server Config =

* S3 has a list of graphServerTag's linking to the GraphHandler serviceTag responsible for the graph
* multiple graphServerTags can point to one GraphHandler, combining graphs into one server
* when creating each GraphHandler's graph schemas, for each field split out the fields into each GraphHandler using the graphServerTag, if multiple graphServerTags for a field point to the same GraphHandler combine the fields to create GraphHandler's graph schema
* every GraphHandler an object is saved into will require it's identifiers
* when eg updating fields for an object separate the fields per GraphHandler before sending the request to update each graph

= Extended Object Types =

* Allows for one graph node to have multiple labels
* graph schema is created for both the core object and the extended object
* eg Media Manager's has a node schema for "media" object type, and Image service has a node schema for "image" object type
* the extended object builds it's schema by combining core + extended settings

= Working documents =

[[:Category:Working_documents - Per Service Schemas|Per Service Schemas]]

2026-03-19 Deploy and Setting EC2 instances

2026-08-08T03:42:57Z

Seagame: /* Download AMI from aws account */

= Deploy EC2 Instance =
* EC2 instance types are purpose-built configurations of virtual servers, designed with different resource combinations to help your applications perform at their best.
== Setting Ec2 on AWS ==

=== Create Key pairs ===
[[File:CreateKeyPairs.png |1000px ]]
* Enter key pair name you want
* select key pair type to RSA
* select Private key file format to .pem
* When you created new key pair it will auto download file it will be used later

=== Create VPC ===
Sign in to aws account that want to create instance -> VPC -> Virtual private cloud -> your VPC
* '''Create VPC if not exist '''
[[File:CreateVPCIfNotExist.png |1000px ]]

* Required: IPv4 CIDR // ex : 172.16.0.0/16

* ''' VCP exist '''
[[File:CreateVPCifExist.png |1000px ]]
*'''Note''' : can shared VPC for create another instance in same account
[[File:Screenshot from 2026-03-18 14-28-11.png|1000px]]

=== Create Subnet ===
[[File:CreateSubNet.png |1000px ]]
* Select VPC
[[File:Screenshot from 2026-03-18 14-55-26.png |1000px ]]
* enter subnet name and select Availability Zone then enter IPv4 subnet CIDR block when you finish first subnet click add new subnet and then repeat 3 subnet process
* Availability Zone
** Stage : Ohio >> (us-east-2a),(us-east-2b),(us-east-2c)
* IPv4 subnet CIDR block
** us-east-2a : 172.16.10.0/24
** us-east-2b : 172.16.20.0/24
** us-east-2c : 172.16.30.0/24

=== Create Internet Gateway ===
* When you finish create internet gateway then back to internet gateways page
* Attach with your VPC: select your internet gateway -> action -> Attach to VPC and then select your VPC

=== Create Route Table ===
[[File:CreateRouteTable.png |1000px ]]
* Select you VPC and then create route table
* Select your route table -> action -> edit subnet associate and then select your subnet
[[File:SubnetAssociations.png |1000px]]
* Connect internet gateway for protect config : Select your route table >> edit route
[[File:EditRoute.png |1000px ]]
* Add route
* Destination : 0.0.0.0/0
* Target : Internet Gateway>> select your Igw from created

=== Create VPC Endpoint ===
[[File:Screenshot from 2026-03-18 15-32-04.png|1000px]]
* '''Select Service:'''
** com.amazonaws.us-east-2.s3
** com.amazonaws.us-east-2.dynamodb
Select Type: Gateway >> VPC >> route table
** com.amazonaws.us-east-2.sns
** com.amazonaws.us-east-2.sqs
** com.amazonaws.us-east-2.lambda
Select Type : Interface >> VPC >> route table >> subnet >> Security groups
* '''Subnet settings'''
[[File:AddSubNet.png |1000px]]
* '''Security groups '''
[[File:AddSequrityGroup.png |1000px]]
* '''Note''' : Endpoint Type : Interface , can create those endpoint after created Security groups from deploy Resource EC2 finished

== Resource Ec2 settings ==
* '''in ResourceEC2/ ec2.yml'''

<syntaxhighlight lang="YAML">
Parameters:

ExistingVpcId:
Type: AWS::EC2::VPC::Id
Description: Use existing VPC
Default: vpc-0ce9f21b10cb179f9

SshKeyPairNeo4j:
Description: SSH Keypair to login to the instance
Type: AWS::EC2::KeyPair::KeyName
Default: ${self:custom.iz_DefaultKeyPairName} # name to config same imageId

Resources:

Neo4jSecurityGroup:
Type: AWS::EC2::SecurityGroup
Properties:
GroupDescription: Neo4j Security Group shared
GroupName: share-neo4j-shared
SecurityGroupIngress:
# - CidrIp: 0.0.0.0/0 # set to all traffic for send msg to sns
# IpProtocol: "-1"
- IpProtocol: tcp
FromPort: 22 # SSH
ToPort: 22
CidrIp: 0.0.0.0/0
- IpProtocol: tcp
FromPort: 7687 # private neo4j port
ToPort: 7687
CidrIp: 0.0.0.0/0
- IpProtocol: tcp
FromPort: 7474 # public neo4j port: neo4j
ToPort: 7474
CidrIp: 0.0.0.0/0
- IpProtocol: tcp
FromPort: 7473 # # public neo4j port: Bolt
ToPort: 7473
CidrIp: 0.0.0.0/0
SecurityGroupEgress:
- CidrIp: 0.0.0.0/0 # set all traffic
IpProtocol: "-1"
# VpcId: !Ref VPC
VpcId: !Ref ExistingVpcId

# create neo4j instance
Neo4jShared:
Type: AWS::EC2::Instance
Properties:
ImageId: ${self:custom.iz_ImageId}
# InstanceInitiatedShutdownBehavior: stop # default
InstanceType: t2.medium
SecurityGroupIds:
- !Ref Neo4jSecurityGroup
KeyName: !Ref 'SshKeyPairNeo4j' # NOTE: require existing keypair, please make sure have private key in local.
SubnetId: ${self:custom.iz_subnetIds1a}

## Elastic IP: neo4j instance public IP address will not chabge everytime we stop/start instance(NOT security)
EIP:
Type: AWS::EC2::EIP
Properties:
InstanceId: !Ref Neo4jShared
</syntaxhighlight>

'''Note:''' Security Group section after deploy if has config between lambda endpoint not send message out… should add setting inbound rules:
* Type:HTTPS>>TPC>>443>>172.16.0.0/16
[[File:AddSettingSequrityGroup.png|1000px]]

= Install Neo4j in terminal =
After EC2 instance was created: ** must have ec2 instance existing **
== Install neo4j using .tar ==
* '''ssh EC2 instance: in Terminal'''

<syntaxhighlight lang="text">
# set permission of key
chmod 400 <your keys pairs> // ex. GraphHandler-ver-05.pem

# connect ec2 instance by SSH command
ssh -i "your-key.pem" ec2-user@<public-ip> -L 7687:<private-ip>:7687

# Install java:
sudo yum install java-17-amazon-corretto -y // neo4j version-5 use java version more than version 11

# Download and extract neo4j
wget https://neo4j.com/artifact.php?name=neo4j-community-5.20.0-unix.tar.gz

tar -xzf neo4j.tar.gz

mv neo4j-community-* neo4j

cd neo4j

# Configure Neo4j bash
nano conf/neo4j.conf

Then Add this into file:

server.default_listen_address=0.0.0.0
server.default_advertised_address=<your-ec2-private-ip or public-ip>
server.bolt.listen_address=:7687
server.http.listen_address=:7474

#Setting start on reboot bash
bin/neo4j stop

sudo nano /etc/systemd/system/neo4j.service

Add this code in file:
[Unit]
Description=Neo4j Graph Database
After=network.target

[Service]
Type=forking
User=ec2-user
WorkingDirectory=/home/ec2-user/neo4j
ExecStart=/home/ec2-user/neo4j/bin/neo4j start
ExecStop=/home/ec2-user/neo4j/bin/neo4j stop
Restart=on-failure
RemainAfterExit=true
Environment=NEO4J_HOME=/home/ec2-user/neo4j
Environment=JAVA_HOME=/usr/lib/jvm/java-17-amazon-corretto

[Install]
WantedBy=multi-user.target

# set neo4j password
bin/neo4j-admin dbms set-initial-password NewPassword123 // < your password>

# Then
bin/neo4j start

</syntaxhighlight>

'''Note:''' If use AMIs exist from another account neo4j browser/backend database will be use old password from that AMIs
* If want to change password with new EC2 instance after install neo4j package

<syntaxhighlight lang="text">
#bash:
sudo systemctl stop neo4j
rm -rf data/dbms/*
rm -rf data/databases/system
rm -rf data/transactions/system
bin/neo4j-admin dbms set-initial-password neo4jComAcc
sudo systemctl start neo4j
</syntaxhighlight>

== Connect Neo4j Browser ==
* run EC2 Instance that connect to neo4j on AWS > Instance state > Start instance : running status
* Example browser : http://16.59.197.49:7474/browser/
* Connect URL:
<syntaxhighlight lang="text">
neo4j:// public -ip:7687
Username: neo4j
Password : xxxxxx
</syntaxhighlight>

= Stop and start EC2 instances automatically =
== Schedules Instance using AWS EventBridge ==
*'''Step1: Specify schedule detail'''
* Go to Amazon EventBridge >> Schedules → Create Schedules
[[File:Step1CreateSpecifyTagEvenBridge.png |1000px]]
* '''Schedule pattern:'''
* Occurrence → Recurring schedule
* Time zone: → asia/Bangkok
* Schedule type → Cron-based schedule
[[File:CronExpression.png |1000px]]
* '''Note:''' monday to saturday stop instance on 18:00 / 6:00PM
* Flexible time window : off → next page

*''' Step2 : Select target '''
[[File:EventBridgeTargetDetial.png|1000px]]
* Amazon EC2 → StopInstances then push Instance Id into JSON format → next page

*'''Step3 : Settings '''
* Schedule state : enable
* Action after schedule completion : NONE
* Retry policy and dead-letter queue (DLQ) : NONE
* Set Permissions: → Go to IAM console to create role permission then select an existing role after created finished
* IAM → Roles → Create roles
** Custom trust policy:
<syntaxhighlight lang="JSON">
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Principal": {
"Service": "scheduler.amazonaws.com"
},
"Action": "sts:AssumeRole"
}
]
}
</syntaxhighlight>

* Add Permission : if permission for stop Instance not exist , have to create before or skip this step then add those permission later
<syntaxhighlight lang="JSON">
{
"Version": "2012-10-17",
"Statement": [
{
"Sid": "VisualEditor0",
"Effect": "Allow",
"Action": "ec2:StopInstances",
"Resource": "arn:aws:ec2:us-east-2:418867772665:instance/i-0569d4b408c5a75db"
}
]
}
</syntaxhighlight>

'''Note:''' "Resource": "arn:aws:ec2:us-east-2:<Account-Id>:instance/<instanceIds>"
* Name, review, and create : create roles name

''' Step4 : Review and create schedule '''
* Check detail the create schedule
// wait for image

== Idea: Stop and start Instance using Systems Manager ==
* Go to AWS → Systems Manager
* In the left menu click → Quick Setup
* Get started with Quick Setup → Get started
* Choose Configuration Type
* 👉 Resource Scheduler (Powered by AWS Solutions) → Create

* Specify instance tag :
** Key : Value >> should set key & value like those instance want to set Auto Scheduler
** go to EC2 Console → Instances
** Select your specific instance
** Click Tags → Manage tags → Add tag

* Target
** Choose : current account and current region
** Local deployment roles : Use new IAM local deployment roles

= Download and Upload AMIs on EC2 =
== Download AMI from aws account ==

* '''Create vmimport Role'''
<syntaxhighlight lang="JSON">
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Principal": {
"Service": "vmie.amazonaws.com"
},
"Action": "sts:AssumeRole",
"Condition": {}
}
]
}
</syntaxhighlight>

*'''Permissions in vmImportPolicy'''
<syntaxhighlight lang="JSON">
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"s3:GetBucketLocation",
"s3:GetObject",
"s3:ListBucket"
],
"Resource": [
"arn:aws:s3:::object-schema",
"arn:aws:s3:::object-schema/*"
]
},
{
"Effect": "Allow",
"Action": [
"s3:PutObject"
],
"Resource": "arn:aws:s3:::object-schema/*"
},
{
"Effect": "Allow",
"Action": [
"ec2:ModifySnapshotAttribute",
"ec2:CopySnapshot",
"ec2:RegisterImage",
"ec2:Describe*"
],
"Resource": "*"
}
]
}
</syntaxhighlight>

*'''Create Role Permission'''
** can create from EC2 instance that want to export AMIs >>Action > security > Modify IAM role name:"instanceExportAMIsPolicy"
<syntaxhighlight lang="JSON">
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"ec2:ExportImage",
"ec2:DescribeImages",
"ec2:DescribeExportImageTasks"
],
"Resource": "*"
},
{
"Effect": "Allow",
"Action": [
"s3:GetObject",
"s3:ListBucket",
"s3:PutObject",
"s3:GetBucketLocation"
],
"Resource": "*"
}
]
}
</syntaxhighlight>
'''Set AWS config'''
<syntaxhighlight lang="text">
AWS Access Key ID [****************SVVH]: xxxxxxxxx
AWS Secret Access Key [****************XESH]: yyyyyyyyy
Default region name [us-east-2]: us-east-2
Default output format [json]: json
</syntaxhighlight>

* Start export task
<syntaxhighlight lang="text">
aws ec2 export-image \
--region us-east-2 \
--image-id <ami-01547ffae334d2ca4> \
--disk-image-format VMDK \
--s3-export-location S3Bucket=object-schema,S3Prefix=exports/
</syntaxhighlight>

* How to check progress
<syntaxhighlight lang="text">
aws ec2 describe-export-image-tasks \
--export-image-task-ids <export-ami-69b4fce2df0ce647t> \
--region us-east-2
</syntaxhighlight>

* Download AMIs
<syntaxhighlight lang="text">
aws s3 cp s3://schema-accounting/exports/<export-ami-69b4fce2df0ce647t.vmdk> .
</syntaxhighlight>

== Upload AMI to aws account ==
** If ami download exist in s3 / aws account can run:
<syntaxhighlight lang="text">
cat > containers.json << 'EOF'
[{
"Description": "neo4j-ami-accounting",
"Format": "vmdk",
"UserBucket": {
"S3Bucket": "schema-accounting",
"S3Key": "exports/export-ami-69b4fce2df0ce647t.vmdk"
}
}]
EOF
</syntaxhighlight>
** If file export-ami-xxx in local terminal | that download from another account, then want to upload into s3 / other aws account run before:
<syntaxhighlight lang="text">
aws s3 cp ~/JangProgramer/export-ami-819afd57ae1eb750t.vmdk \
s3://schema-accounting/exports/
</syntaxhighlight>

<syntaxhighlight lang="text">
aws ec2 import-image \
--description "Neo4j AMI Import" \
--disk-containers file://containers.json \
--region us-east-2
</syntaxhighlight>

<syntaxhighlight lang="text">
* check status
aws ec2 describe-export-image-tasks // check status
aws ec2 describe-import-image-tasks //
</syntaxhighlight>
[[Category:Working documents| 2026-03-19]]

Per Service Schemas

2026-07-30T02:08:27Z

Seagame: /* Flow Schema | FlowSchemas.js */

= Overview =

Each service manages a schema of object/resources that it is responsible for, this schema is available to other services and frontends. The schema includes a list of fields available for each object.

= File Structure =

* see [[Repository structure#schemas|Repository structure]]

= ObjectSchema | ObjectFieldSchema.js =

== Not extendObjType ==

<syntaxhighlight lang="javascript">
{
objectType: "xx",
shortNameObjectType:"x", // optional, use when generate code create lambda role with long name
canDelete: false, // whether any fields can be deleted // default = false
belongTo: {
serviceTag:"iii",
objectType:"jjj"
},
// how is the object created
// userGenerated there will be generated endpoints for api or sqs (used in importBatchMain) to create object
// systemGenerated must be created by flow/s
// searchResultGenerated see separate notes below
generatedBy: "userGenerated" || "systemGenerated" || "searchResultGenerated" // required
searchResultGeneratedFlowType: {}, // for generatedBy = searchResultGenerated
addOnDataStructure: [ // optional, add for additional setting to objectType
{
// all fields that a user can edit must be in versionedData, and all fields in versionedData must be editable by user
type:"versionedData",
versionedDataLabel: "xx", // versionedData label name
storageResourceTag : "xx", // ref to storegeResourceTag
fieldNames: { // fieldName in versionedData cannot have in in main objectSchema.fieldNames
"aaa":{ // fieldName
type: "xx", // string|integer|number|timestamp|currency|currencyValue|float|special|object|boolean|arrayMixed|arrayNumeric|arrayString
requiredOnCreate: false, // default = false
optionalOnCreate: false, // default = false,
validation: {
itemValidation:{} // for validate item in array
},
// probably impossible to have fromObjType, because data can be changed by user here
fromObjType:{
serviceTag: "xxx",
objectType: "xxx"
},
},
// ...
}
},
{ // can have multiple addOn of type attributeTree
type:"attributeTree",
},
{
type:"translation"
},
{
type:"propertyValue"
},
{
type:"mediaLink"
},
{
type:"rbac"
},
// ...
],
plugInTags: ["a", "b"], // plugIns that can be connected to this objType
storageResources:{
"xxx":{ // storageResourceTag
storageType: "xx", // graph
graphServerTag: "xx", // setting for storageType graph
additionalGraphIndexes:[['fieldName1', 'fieldName2', ...], [...]] // will make graph index with specific fieldName
},
"zzz":{ // storageResourceTag
storageType: "xx", // dynamoDB
// setting for storageType dynamoDB
tableName: "xx",
groupByPartitionKeyField: "xx", // use groupByPartitionKeyField as partition key and not have sort key in dynamoDB, if have multiple identifiers will concat it. And use it as partitionKey.
serviceTag:"zz"// default own service.
}
},
fieldNames: {
xxx: { // fieldName
type: "xx", // string|integer|number|timestamp|currency|currencyValue|float|special|object|boolean|arrayMixed|arrayNumeric|arrayString
randomOnCreate: false, // default = false , can set true in fieldName that part of identifiers and identifiers have single identifierFieldname
requiredOnCreate: false, // default = false
optionalOnCreate: false, // default = false
canUpdate: true, // default = true (only system/flows can edit, no history of changes unless flow manually adds)
validation: {
itemValidation:{} // for validate item in array
}, // maybe ajv syntax
storageResourceTags: ["xx","yy"], // reference to storageResources property
fromObjType:{
serviceTag: "xxx",
objectType: "xxx"
},
hashOnCreate: ["xx", "yy"], // reference to other fieldName,
statusField: true, // use for objectSchema inside flowSchema, identify which field is statusField

// comes from requiredOnCreate relationships
fromRequiredOnCreate: {
relType: {
serviceTag:"aa",
relationshipTag:"bb"
},
// or
belongToObjType: true, // if set to true use the belongTo relationship to belongTo objType

fieldName:"" // optional default= same field name eg: now default == xxx if not defined(use fieldname of object inside link when create)
}
},
// ...
},
compositeKeyDeliminator: "xx", // join partitionKey and sortKey
identifiers: [
// for dynamoDB storageType
{
type: "partitionKey",

fieldNames: ["xx","yy"], // composite partition keys in DynamoDB
deliminator: "xx", // optional, defaults to "_"
name: "zz", // name of field in database
// or
fieldName: "xx"

},
{
type: "sortKey",

fieldNames: ["xx","yy"], // composite partition keys in DynamoDB
deliminator: "xx", // optional, defaults to "_"
name: "zz", // name of field in database
// or
fieldName: "xx"

},

// for graph storageType
{
type: "identifier",
fieldNames: ["xx","yy"], // identifier field in graph or composite partition keys in DynamoDB
name: "zzz" // use when save in dynamoDB partitionKey
deliminator: "xx", // optional, defaults to "_"
// or
fieldName: "xx"
},
]
}
</syntaxhighlight>

== extendObjType ==

<syntaxhighlight lang="javascript">
{
// for objects stored in graph this will add another node label
objectType: "xx", // new label to add
extendObjType: { // core object that this object extends
serviceTag: "xxx",
objectType: "xxx"
},
addOnDataStructure: [],
storageResources:{ // these are the storageResources that carry the extended objects settings,
// (see above)
},
fieldNames: {
// (see above)
},
// canDelete/identifiers come from the core object
}
</syntaxhighlight>

== searchResultGenerated ==

* must be created by flow
* eg: variantProduct
* not have any storageResources
* identifiers are automatically searchResultData identifiers
* a searchResult request for this object will enter the searchResultGeneratedFlowType flow which creates searchResultData that can then be queried/sorted
* all relationships must be storageType = lambda, eg translate from variantProduct to variant uses a translateId flow to query the variantProduct identifier (searchResultData) to find the variantId in it's requiredData results
* searchResultGeneratedFlowType takes over after creating searchResultMain record until processRequiredData
* if objectSchema defines any fieldnames, then they are found using a flow, maybe as hooks in per service findData
* when finding direct fieldname, will need to check if requireData already exists, if not enter flow/findData to create
* no fields can be edited, so can show in forms but no updates performed

= Relationships Schema | ObjectRelationships.js =

* stored in top level schemas folder
* parent/child determines relationship direction for graph relationships
* have one service that contains information of each relationship

<syntaxhighlight lang="javascript">
// relationship schema in responsible service
[
{
"xxx": { // relationshipTag - name of relationship type stored in graph
generatedBy: "userGenerated" || "systemGenerated" // default="userGenerated"
canChangeToRelTypes: [
{
relType: { // relType that this relType can change to
serviceTag:"xxx",
relationshipTag: "yyy"
},
changeBy: "user" // "systemNoUserId" | "systemWithUserId" | "user", default="user"
}
// another relType
],
storageResources:{
"xxx":{ // storageResourceTag
storageType: "xx", // dynamoDB | graph | lambda
// if storageType="dynamoDB" will not specify tableName in relationship schema

// setting for storageType graph
graphServerTag: "xx",
additionalGraphIndexes:[['fieldName1', 'fieldName2', ...], [...]], // will make graph index with specific fieldName

// setting for storageType lambda
serviceTag: "xx",
functionName: "xx",
}
},
fieldNames: {
"xxx": { // relationship property name
type: "string", // "string" | "number" ...
requiredOnCreate: false, // default=false
optionalOnCreate: false, // default = false
updateBy: "user" // "systemNoUserId" | "systemWithUserId" | "user" | "none", default="user"
validation: {} // ajv syntax
},
//...other relationship properties
},
links: [
{
storageResourceTags: ["xxx"], // reference from storageResources property
canDelete: false // default = false, if set true will allow delete relationship between 2 objType
from: {
objType: {
serviceTag: "xx",
objectType: "xx"
},
requiredOnCreate: true, // if set true will create relationshipTag when create objType data, if both "from" and "to" linkType="many" should not have requiredOnCreate, exists in "from" or "to" only
linkType: "", // one | many
// moveBy: "none", // "systemNoUserId" | "systemWithUserId" | "user" | "none", default="none"
// belongTo:true
},
to: {
objType: {
serviceTag: "yy",
objectType: "yy"
},
linkType: "", // one | many
// moveBy allows the relationship to be moved between 2 instances of the same objType only
moveBy: "none", // "systemNoUserId" | "systemWithUserId" | "user" | "none", default="none"
belongTo:true, // false
},
requestProperties: {
// if storageType is Lambda and translateIds/linkPath requires properties set them here (eg sellOffer>orderPrice)
tag_deliverTo: {
requestPropertyType: "objectIdentifier",
objType: {
serviceTag: "Locations",
objectType: "locationNode" // deliversToLocationNode
},
identifiersFieldName: "locationNodeId"
},
// ... other request properties
}
}
// ...other link
]
}
}
]

</syntaxhighlight>

= Reference Relationships Schema | RefObjectRelationships.js =

<syntaxhighlight lang="javascript">
// reference to relationshipTag in external service
[
{
objectType: "zz", // objectType in local service
relationshipTag: "xxx", // name of relationshiptag of objType
relationshipServiceTag: "xx" // point to service tag that contain data of relationshipTag of objType
}
]

</syntaxhighlight>

= Flow Schema | FlowSchemas.js =

<syntaxhighlight lang="javascript">
[
{
flowTag: "yyy",
initiateBy:"user", // "user" | "system" -- if receive plugin should be user
handleObj:"one", // "one" | "multi"
statusType:"statusField", // "statusField" | "storedCache" | "none" | "triggerCache"

// statusType="triggerCache" setting
triggerType: "storedCache", // "storedCache" | "switch"
triggerFlowTypes:[
//... triggerFlowType
],

// statusType="statusField" | "triggerCache" | "storedCache" setting:
objType:{},

event:["ownTopic"], // "ownTopic" | "extTopic" | "s3" | "eventBridge" | "lambdaSyncInv" | "lambdaSyncApi" | "generatedCode" | "dsq"

// event="s3" setting
bucketName: "xxx", // bucket for s3 event
createBucket: boolean, // if true will generate new bucket with bucketName if false will point to old bucket that already have

// event="eventBridge" setting
schedules:[
{
name: 'your-scheduled-rate-event-name',
description: 'your scheduled rate event description',
rate: ["rate(1 minute)", ],
input:{}
}
],

// event="generatedCode" setting
generatedCodeConfig:{
generatedCodeTag: "create", // tag for generated code, eg "create" | "update" | "delete"
codeHookTag: "xx", // which codeHook to initiate flow from
// maybe validate: invocationType must exist in "event" array, so don't need to check 2 places when eg creating sns topic
invocationType: "ownTopic", // "ownTopic" | "lambdaSyncInv"

objType: {}, // which cases in the generated code trigger the flow
// .. other settings depending on generated code
}

outputTopic: boolean,

flowSteps:[
inTag:{ // will generate Topic serviceTag_stage_yyy_inTag
properties:[], // reference to stepProperties key, the first lambda's input properties and messageAttributes are the flow's input properties and messageAttributes
messageAttributes: [], // reference to stepProperties key
plugInHooks: [
{
plugInHookTag: "",
objType:{}, // used to query connection dynamo for an object instance in current flow
},
],
returnValues: {
properties:[], // reference to stepProperties key
messageAttributes: [], // reference to stepProperties key, only for outputTopic=true
},

},
// another flow steps
flowStep1:{ // will generate Topic serviceTag_stage_yyy_Flow1
properties:[], // reference to stepProperties key
messageAttributes: [] // reference to stepProperties key
event:["ownTopic"], // "ownTopic" | "extTopic" | "s3" | "eventBridge" | "lambdaSyncInv" | "lambdaSyncApi" | "generatedCode" | "dsq"
// handle splitting logic into awaitingStep/awaitingMultipleSteps
// handle splitting logic into paginated lambda

plugInHooks: [
{
plugInHookTag: "",
objType:{}, // used to query connection dynamo for an object instance in current flow
},
],
returnValues: { // the last lambda function returnValues are the flow's returnValues
properties:[], // reference to stepProperties key
messageAttributes: [], // reference to stepProperties key, only for outputTopic=true
},

},
]

stepProperties:{ // normalized all stepProperties
"uuid":{
propertyName:"xxx",
type:"object",
required:false, // true | false default=false
childProperties:["uuid2", "uuid3"]
},
"uuid2":{
propertyName:"xxx",
required:false, // true | false default=false
type:"string",
},
"uuid3":{
propertyName:"xxx",
required:false, // true | false default=false
type:"string",
},
"uuid4":{
required:false, // true | false default=false
objectField:{
objType:{},
fieldName:"xx"
},
overwritePropertyName:"xx" // optional, if have objectField and have overwritePropertyName will overwrite fieldName
}
},
stepMessageAttributes:{ // normalized all stepMessageAttributes
"uuid":{
propertyName:"xxx",
required:false, // true | false default=false
type:"string",
},
"uuid2":{
propertyName:"yyy",
required:false, // true | false default=false
type:"string",
}
},
}
]
</syntaxhighlight>

= System Text Schema | SystemTextSchemas.js =

<syntaxhighlight lang="javascript">
[
{
namespace: "xxx", // groups files downloaded by frontend
systemTextTag: "yyy",
}
]
</syntaxhighlight>

== Auto generated systemText and namespaces ==

=== systemNotification names ===

* namespace: "sysNotification_{notificationGrouping}"
* systemTextTag: "{notificationTag}"
* eg shown on notification settings page

=== objType names ===

* namespace: "objTypes"
* systemTextTag: "{serviceTag}_{objectType}"
* eg shown on config pages, eg pulldown list of object types

=== objType field name descriptions ===

* namespace: "objType_fielddesc_{serviceTag}_{objectType}"
* systemTextTag: "{fieldname}"
* eg shown on config pages, eg info box for each field name

= System Notification Schema | SystemNotificationSchemas.js =

<syntaxhighlight lang="javascript">
[
{
notificationTag: "xxx",
notificationGrouping: "yyy",
weight: "##",
},
]
</syntaxhighlight>

= Generated S3 files =

* generate multiple files for different uses, eg:
*# list of saved fieldNames for Create
*# list of saved+calculated for Update/Info pages
*# graphSchemas
*# relationships (used by Search/Sort Results)

= Use Cases =

== Find Deployed Service Name ==

* other services can use fixed serviceTag to get deployed serviceName from serviceSchema on S3
* used to build resource names for external services
* eg when one service needs to send a message into an SNS belonging to a different service

== Standard Create, Update, List, Delete pages ==

* List and Delete are maybe not required, use table data system instead.
* object schema can add validation information that can be used on the frontend to check before sending to backend, and by the backend to validate the data before handling

=== Create Object ===

* can configure what fields are shown
* requiredOnCreate fields must be shown

=== Edit Object ===

* users setup any number of pages for object types with configurable fields shown
* fields can be either display only or edit
* each field can adjust it's display properties (perhaps via cssStyles)

== Menu Config ==

When adding menu items can add links to create, update, list, delete objects, user chooses the service then from that service's list of objects and what action is being performed. For update/delete perhaps links to a standard page that asks for the identifier before presenting the page.

== Tabled Data ==

When viewing tabled data the frontend pulls the tableId's config from backend, then when requesting the data also requests the serviceTag > objectType schema for use when displaying the data.

== Code Standardization ==

Code such as middleware validation schema and saving data to databases can be standardized.

== Code Generation ==

Endpoints per object for actions such as Create/Delete/Update can be automatically generated from objectSchema.

=== Code Generation Structure ===

* npm for generic code generation, can be used in any project, includes functions for generating Source files from templates and developer files
* npm for per project specific files, eg templates for the project (Create/Update/.. code)
* Empty Service Template has GenerateCode.js script file in root dir that is run to generate code, it invokes a generation function from generic npm with param that points to per project npm's templates
* generated Source retains hook tags (and any developer added code), so if developer wants to update developer's file with updated template code they can generate code and simply copy generated Source to src folder

= Graph Server Config =

* S3 has a list of graphServerTag's linking to the GraphHandler serviceTag responsible for the graph
* multiple graphServerTags can point to one GraphHandler, combining graphs into one server
* when creating each GraphHandler's graph schemas, for each field split out the fields into each GraphHandler using the graphServerTag, if multiple graphServerTags for a field point to the same GraphHandler combine the fields to create GraphHandler's graph schema
* every GraphHandler an object is saved into will require it's identifiers
* when eg updating fields for an object separate the fields per GraphHandler before sending the request to update each graph

= Extended Object Types =

* Allows for one graph node to have multiple labels
* graph schema is created for both the core object and the extended object
* eg Media Manager's has a node schema for "media" object type, and Image service has a node schema for "image" object type
* the extended object builds it's schema by combining core + extended settings

= Working documents =

[[:Category:Working_documents - Per Service Schemas|Per Service Schemas]]

Per Service Schemas

2026-07-29T07:05:47Z

Seagame: /* Flow Schema | FlowSchemas.js */

= Overview =

Each service manages a schema of object/resources that it is responsible for, this schema is available to other services and frontends. The schema includes a list of fields available for each object.

= File Structure =

* see [[Repository structure#schemas|Repository structure]]

= ObjectSchema | ObjectFieldSchema.js =

== Not extendObjType ==

<syntaxhighlight lang="javascript">
{
objectType: "xx",
shortNameObjectType:"x", // optional, use when generate code create lambda role with long name
canDelete: false, // whether any fields can be deleted // default = false
belongTo: {
serviceTag:"iii",
objectType:"jjj"
},
// how is the object created
// userGenerated there will be generated endpoints for api or sqs (used in importBatchMain) to create object
// systemGenerated must be created by flow/s
// searchResultGenerated see separate notes below
generatedBy: "userGenerated" || "systemGenerated" || "searchResultGenerated" // required
searchResultGeneratedFlowType: {}, // for generatedBy = searchResultGenerated
addOnDataStructure: [ // optional, add for additional setting to objectType
{
// all fields that a user can edit must be in versionedData, and all fields in versionedData must be editable by user
type:"versionedData",
versionedDataLabel: "xx", // versionedData label name
storageResourceTag : "xx", // ref to storegeResourceTag
fieldNames: { // fieldName in versionedData cannot have in in main objectSchema.fieldNames
"aaa":{ // fieldName
type: "xx", // string|integer|number|timestamp|currency|currencyValue|float|special|object|boolean|arrayMixed|arrayNumeric|arrayString
requiredOnCreate: false, // default = false
optionalOnCreate: false, // default = false,
validation: {
itemValidation:{} // for validate item in array
},
// probably impossible to have fromObjType, because data can be changed by user here
fromObjType:{
serviceTag: "xxx",
objectType: "xxx"
},
},
// ...
}
},
{ // can have multiple addOn of type attributeTree
type:"attributeTree",
},
{
type:"translation"
},
{
type:"propertyValue"
},
{
type:"mediaLink"
},
{
type:"rbac"
},
// ...
],
plugInTags: ["a", "b"], // plugIns that can be connected to this objType
storageResources:{
"xxx":{ // storageResourceTag
storageType: "xx", // graph
graphServerTag: "xx", // setting for storageType graph
additionalGraphIndexes:[['fieldName1', 'fieldName2', ...], [...]] // will make graph index with specific fieldName
},
"zzz":{ // storageResourceTag
storageType: "xx", // dynamoDB
// setting for storageType dynamoDB
tableName: "xx",
groupByPartitionKeyField: "xx", // use groupByPartitionKeyField as partition key and not have sort key in dynamoDB, if have multiple identifiers will concat it. And use it as partitionKey.
serviceTag:"zz"// default own service.
}
},
fieldNames: {
xxx: { // fieldName
type: "xx", // string|integer|number|timestamp|currency|currencyValue|float|special|object|boolean|arrayMixed|arrayNumeric|arrayString
randomOnCreate: false, // default = false , can set true in fieldName that part of identifiers and identifiers have single identifierFieldname
requiredOnCreate: false, // default = false
optionalOnCreate: false, // default = false
canUpdate: true, // default = true (only system/flows can edit, no history of changes unless flow manually adds)
validation: {
itemValidation:{} // for validate item in array
}, // maybe ajv syntax
storageResourceTags: ["xx","yy"], // reference to storageResources property
fromObjType:{
serviceTag: "xxx",
objectType: "xxx"
},
hashOnCreate: ["xx", "yy"], // reference to other fieldName,
statusField: true, // use for objectSchema inside flowSchema, identify which field is statusField

// comes from requiredOnCreate relationships
fromRequiredOnCreate: {
relType: {
serviceTag:"aa",
relationshipTag:"bb"
},
// or
belongToObjType: true, // if set to true use the belongTo relationship to belongTo objType

fieldName:"" // optional default= same field name eg: now default == xxx if not defined(use fieldname of object inside link when create)
}
},
// ...
},
compositeKeyDeliminator: "xx", // join partitionKey and sortKey
identifiers: [
// for dynamoDB storageType
{
type: "partitionKey",

fieldNames: ["xx","yy"], // composite partition keys in DynamoDB
deliminator: "xx", // optional, defaults to "_"
name: "zz", // name of field in database
// or
fieldName: "xx"

},
{
type: "sortKey",

fieldNames: ["xx","yy"], // composite partition keys in DynamoDB
deliminator: "xx", // optional, defaults to "_"
name: "zz", // name of field in database
// or
fieldName: "xx"

},

// for graph storageType
{
type: "identifier",
fieldNames: ["xx","yy"], // identifier field in graph or composite partition keys in DynamoDB
name: "zzz" // use when save in dynamoDB partitionKey
deliminator: "xx", // optional, defaults to "_"
// or
fieldName: "xx"
},
]
}
</syntaxhighlight>

== extendObjType ==

<syntaxhighlight lang="javascript">
{
// for objects stored in graph this will add another node label
objectType: "xx", // new label to add
extendObjType: { // core object that this object extends
serviceTag: "xxx",
objectType: "xxx"
},
addOnDataStructure: [],
storageResources:{ // these are the storageResources that carry the extended objects settings,
// (see above)
},
fieldNames: {
// (see above)
},
// canDelete/identifiers come from the core object
}
</syntaxhighlight>

== searchResultGenerated ==

* must be created by flow
* eg: variantProduct
* not have any storageResources
* identifiers are automatically searchResultData identifiers
* a searchResult request for this object will enter the searchResultGeneratedFlowType flow which creates searchResultData that can then be queried/sorted
* all relationships must be storageType = lambda, eg translate from variantProduct to variant uses a translateId flow to query the variantProduct identifier (searchResultData) to find the variantId in it's requiredData results
* searchResultGeneratedFlowType takes over after creating searchResultMain record until processRequiredData
* if objectSchema defines any fieldnames, then they are found using a flow, maybe as hooks in per service findData
* when finding direct fieldname, will need to check if requireData already exists, if not enter flow/findData to create
* no fields can be edited, so can show in forms but no updates performed

= Relationships Schema | ObjectRelationships.js =

* stored in top level schemas folder
* parent/child determines relationship direction for graph relationships
* have one service that contains information of each relationship

<syntaxhighlight lang="javascript">
// relationship schema in responsible service
[
{
"xxx": { // relationshipTag - name of relationship type stored in graph
generatedBy: "userGenerated" || "systemGenerated" // default="userGenerated"
canChangeToRelTypes: [
{
relType: { // relType that this relType can change to
serviceTag:"xxx",
relationshipTag: "yyy"
},
changeBy: "user" // "systemNoUserId" | "systemWithUserId" | "user", default="user"
}
// another relType
],
storageResources:{
"xxx":{ // storageResourceTag
storageType: "xx", // dynamoDB | graph | lambda
// if storageType="dynamoDB" will not specify tableName in relationship schema

// setting for storageType graph
graphServerTag: "xx",
additionalGraphIndexes:[['fieldName1', 'fieldName2', ...], [...]], // will make graph index with specific fieldName

// setting for storageType lambda
serviceTag: "xx",
functionName: "xx",
}
},
fieldNames: {
"xxx": { // relationship property name
type: "string", // "string" | "number" ...
requiredOnCreate: false, // default=false
optionalOnCreate: false, // default = false
updateBy: "user" // "systemNoUserId" | "systemWithUserId" | "user" | "none", default="user"
validation: {} // ajv syntax
},
//...other relationship properties
},
links: [
{
storageResourceTags: ["xxx"], // reference from storageResources property
canDelete: false // default = false, if set true will allow delete relationship between 2 objType
from: {
objType: {
serviceTag: "xx",
objectType: "xx"
},
requiredOnCreate: true, // if set true will create relationshipTag when create objType data, if both "from" and "to" linkType="many" should not have requiredOnCreate, exists in "from" or "to" only
linkType: "", // one | many
// moveBy: "none", // "systemNoUserId" | "systemWithUserId" | "user" | "none", default="none"
// belongTo:true
},
to: {
objType: {
serviceTag: "yy",
objectType: "yy"
},
linkType: "", // one | many
// moveBy allows the relationship to be moved between 2 instances of the same objType only
moveBy: "none", // "systemNoUserId" | "systemWithUserId" | "user" | "none", default="none"
belongTo:true, // false
},
requestProperties: {
// if storageType is Lambda and translateIds/linkPath requires properties set them here (eg sellOffer>orderPrice)
tag_deliverTo: {
requestPropertyType: "objectIdentifier",
objType: {
serviceTag: "Locations",
objectType: "locationNode" // deliversToLocationNode
},
identifiersFieldName: "locationNodeId"
},
// ... other request properties
}
}
// ...other link
]
}
}
]

</syntaxhighlight>

= Reference Relationships Schema | RefObjectRelationships.js =

<syntaxhighlight lang="javascript">
// reference to relationshipTag in external service
[
{
objectType: "zz", // objectType in local service
relationshipTag: "xxx", // name of relationshiptag of objType
relationshipServiceTag: "xx" // point to service tag that contain data of relationshipTag of objType
}
]

</syntaxhighlight>

= Flow Schema | FlowSchemas.js =

<syntaxhighlight lang="javascript">
[
{
flowTag: "yyy",
initiateBy:"user", // "user" | "system" -- if receive plugin should be user
handleObj:"one", // "one" | "multi"
statusType:"statusField", // "statusField" | "storedCache" | "none" | "triggerCache"

// statusType="triggerCache" setting
triggerType: "storedCache", // "storedCache" | "switch"
triggerFlowTypes:[
//... triggerFlowType
],

// statusType="statusField" | "triggerCache" | "storedCache" setting:
objType:{},

event:["ownTopic"], // "ownTopic" | "extTopic" | "s3" | "eventBridge" | "lambdaSyncInv" | "lambdaSyncApi" | "generatedCode"

// event="s3" setting
bucketName: "xxx", // bucket for s3 event
createBucket: boolean, // if true will generate new bucket with bucketName if false will point to old bucket that already have

// event="eventBridge" setting
schedules:[
{
name: 'your-scheduled-rate-event-name',
description: 'your scheduled rate event description',
rate: ["rate(1 minute)", ],
input:{}
}
],

// event="generatedCode" setting
generatedCodeConfig:{
generatedCodeTag: "create", // tag for generated code, eg "create" | "update" | "delete"
codeHookTag: "xx", // which codeHook to initiate flow from
// maybe validate: invocationType must exist in "event" array, so don't need to check 2 places when eg creating sns topic
invocationType: "ownTopic", // "ownTopic" | "lambdaSyncInv"

objType: {}, // which cases in the generated code trigger the flow
// .. other settings depending on generated code
}

outputTopic: boolean,

flowSteps:[
inTag:{ // will generate Topic serviceTag_stage_yyy_inTag
properties:[], // reference to stepProperties key, the first lambda's input properties and messageAttributes are the flow's input properties and messageAttributes
messageAttributes: [], // reference to stepProperties key
plugInHooks: [
{
plugInHookTag: "",
objType:{}, // used to query connection dynamo for an object instance in current flow
},
],
returnValues: {
properties:[], // reference to stepProperties key
messageAttributes: [], // reference to stepProperties key, only for outputTopic=true
},

},
// another flow steps
flowStep1:{ // will generate Topic serviceTag_stage_yyy_Flow1
properties:[], // reference to stepProperties key
messageAttributes: [] // reference to stepProperties key
event:["ownTopic"], // "ownTopic" | "extTopic" | "s3" | "eventBridge" | "lambdaSyncInv" | "lambdaSyncApi" | "generatedCode"
// handle splitting logic into awaitingStep/awaitingMultipleSteps
// handle splitting logic into paginated lambda

plugInHooks: [
{
plugInHookTag: "",
objType:{}, // used to query connection dynamo for an object instance in current flow
},
],
returnValues: { // the last lambda function returnValues are the flow's returnValues
properties:[], // reference to stepProperties key
messageAttributes: [], // reference to stepProperties key, only for outputTopic=true
},

},
]

stepProperties:{ // normalized all stepProperties
"uuid":{
propertyName:"xxx",
type:"object",
required:false, // true | false default=false
childProperties:["uuid2", "uuid3"]
},
"uuid2":{
propertyName:"xxx",
required:false, // true | false default=false
type:"string",
},
"uuid3":{
propertyName:"xxx",
required:false, // true | false default=false
type:"string",
},
"uuid4":{
required:false, // true | false default=false
objectField:{
objType:{},
fieldName:"xx"
},
overwritePropertyName:"xx" // optional, if have objectField and have overwritePropertyName will overwrite fieldName
}
},
stepMessageAttributes:{ // normalized all stepMessageAttributes
"uuid":{
propertyName:"xxx",
required:false, // true | false default=false
type:"string",
},
"uuid2":{
propertyName:"yyy",
required:false, // true | false default=false
type:"string",
}
},
}
]
</syntaxhighlight>

= System Text Schema | SystemTextSchemas.js =

<syntaxhighlight lang="javascript">
[
{
namespace: "xxx", // groups files downloaded by frontend
systemTextTag: "yyy",
}
]
</syntaxhighlight>

== Auto generated systemText and namespaces ==

=== systemNotification names ===

* namespace: "sysNotification_{notificationGrouping}"
* systemTextTag: "{notificationTag}"
* eg shown on notification settings page

=== objType names ===

* namespace: "objTypes"
* systemTextTag: "{serviceTag}_{objectType}"
* eg shown on config pages, eg pulldown list of object types

=== objType field name descriptions ===

* namespace: "objType_fielddesc_{serviceTag}_{objectType}"
* systemTextTag: "{fieldname}"
* eg shown on config pages, eg info box for each field name

= System Notification Schema | SystemNotificationSchemas.js =

<syntaxhighlight lang="javascript">
[
{
notificationTag: "xxx",
notificationGrouping: "yyy",
weight: "##",
},
]
</syntaxhighlight>

= Generated S3 files =

* generate multiple files for different uses, eg:
*# list of saved fieldNames for Create
*# list of saved+calculated for Update/Info pages
*# graphSchemas
*# relationships (used by Search/Sort Results)

= Use Cases =

== Find Deployed Service Name ==

* other services can use fixed serviceTag to get deployed serviceName from serviceSchema on S3
* used to build resource names for external services
* eg when one service needs to send a message into an SNS belonging to a different service

== Standard Create, Update, List, Delete pages ==

* List and Delete are maybe not required, use table data system instead.
* object schema can add validation information that can be used on the frontend to check before sending to backend, and by the backend to validate the data before handling

=== Create Object ===

* can configure what fields are shown
* requiredOnCreate fields must be shown

=== Edit Object ===

* users setup any number of pages for object types with configurable fields shown
* fields can be either display only or edit
* each field can adjust it's display properties (perhaps via cssStyles)

== Menu Config ==

When adding menu items can add links to create, update, list, delete objects, user chooses the service then from that service's list of objects and what action is being performed. For update/delete perhaps links to a standard page that asks for the identifier before presenting the page.

== Tabled Data ==

When viewing tabled data the frontend pulls the tableId's config from backend, then when requesting the data also requests the serviceTag > objectType schema for use when displaying the data.

== Code Standardization ==

Code such as middleware validation schema and saving data to databases can be standardized.

== Code Generation ==

Endpoints per object for actions such as Create/Delete/Update can be automatically generated from objectSchema.

=== Code Generation Structure ===

* npm for generic code generation, can be used in any project, includes functions for generating Source files from templates and developer files
* npm for per project specific files, eg templates for the project (Create/Update/.. code)
* Empty Service Template has GenerateCode.js script file in root dir that is run to generate code, it invokes a generation function from generic npm with param that points to per project npm's templates
* generated Source retains hook tags (and any developer added code), so if developer wants to update developer's file with updated template code they can generate code and simply copy generated Source to src folder

= Graph Server Config =

* S3 has a list of graphServerTag's linking to the GraphHandler serviceTag responsible for the graph
* multiple graphServerTags can point to one GraphHandler, combining graphs into one server
* when creating each GraphHandler's graph schemas, for each field split out the fields into each GraphHandler using the graphServerTag, if multiple graphServerTags for a field point to the same GraphHandler combine the fields to create GraphHandler's graph schema
* every GraphHandler an object is saved into will require it's identifiers
* when eg updating fields for an object separate the fields per GraphHandler before sending the request to update each graph

= Extended Object Types =

* Allows for one graph node to have multiple labels
* graph schema is created for both the core object and the extended object
* eg Media Manager's has a node schema for "media" object type, and Image service has a node schema for "image" object type
* the extended object builds it's schema by combining core + extended settings

= Working documents =

[[:Category:Working_documents - Per Service Schemas|Per Service Schemas]]

Per Service Schemas

2026-07-29T05:24:00Z

Seagame: /* Flow Schema | FlowSchemas.js */

= Overview =

Each service manages a schema of object/resources that it is responsible for, this schema is available to other services and frontends. The schema includes a list of fields available for each object.

= File Structure =

* see [[Repository structure#schemas|Repository structure]]

= ObjectSchema | ObjectFieldSchema.js =

== Not extendObjType ==

<syntaxhighlight lang="javascript">
{
objectType: "xx",
shortNameObjectType:"x", // optional, use when generate code create lambda role with long name
canDelete: false, // whether any fields can be deleted // default = false
belongTo: {
serviceTag:"iii",
objectType:"jjj"
},
// how is the object created
// userGenerated there will be generated endpoints for api or sqs (used in importBatchMain) to create object
// systemGenerated must be created by flow/s
// searchResultGenerated see separate notes below
generatedBy: "userGenerated" || "systemGenerated" || "searchResultGenerated" // required
searchResultGeneratedFlowType: {}, // for generatedBy = searchResultGenerated
addOnDataStructure: [ // optional, add for additional setting to objectType
{
// all fields that a user can edit must be in versionedData, and all fields in versionedData must be editable by user
type:"versionedData",
versionedDataLabel: "xx", // versionedData label name
storageResourceTag : "xx", // ref to storegeResourceTag
fieldNames: { // fieldName in versionedData cannot have in in main objectSchema.fieldNames
"aaa":{ // fieldName
type: "xx", // string|integer|number|timestamp|currency|currencyValue|float|special|object|boolean|arrayMixed|arrayNumeric|arrayString
requiredOnCreate: false, // default = false
optionalOnCreate: false, // default = false,
validation: {
itemValidation:{} // for validate item in array
},
// probably impossible to have fromObjType, because data can be changed by user here
fromObjType:{
serviceTag: "xxx",
objectType: "xxx"
},
},
// ...
}
},
{ // can have multiple addOn of type attributeTree
type:"attributeTree",
},
{
type:"translation"
},
{
type:"propertyValue"
},
{
type:"mediaLink"
},
{
type:"rbac"
},
// ...
],
plugInTags: ["a", "b"], // plugIns that can be connected to this objType
storageResources:{
"xxx":{ // storageResourceTag
storageType: "xx", // graph
graphServerTag: "xx", // setting for storageType graph
additionalGraphIndexes:[['fieldName1', 'fieldName2', ...], [...]] // will make graph index with specific fieldName
},
"zzz":{ // storageResourceTag
storageType: "xx", // dynamoDB
// setting for storageType dynamoDB
tableName: "xx",
groupByPartitionKeyField: "xx", // use groupByPartitionKeyField as partition key and not have sort key in dynamoDB, if have multiple identifiers will concat it. And use it as partitionKey.
serviceTag:"zz"// default own service.
}
},
fieldNames: {
xxx: { // fieldName
type: "xx", // string|integer|number|timestamp|currency|currencyValue|float|special|object|boolean|arrayMixed|arrayNumeric|arrayString
randomOnCreate: false, // default = false , can set true in fieldName that part of identifiers and identifiers have single identifierFieldname
requiredOnCreate: false, // default = false
optionalOnCreate: false, // default = false
canUpdate: true, // default = true (only system/flows can edit, no history of changes unless flow manually adds)
validation: {
itemValidation:{} // for validate item in array
}, // maybe ajv syntax
storageResourceTags: ["xx","yy"], // reference to storageResources property
fromObjType:{
serviceTag: "xxx",
objectType: "xxx"
},
hashOnCreate: ["xx", "yy"], // reference to other fieldName,
statusField: true, // use for objectSchema inside flowSchema, identify which field is statusField

// comes from requiredOnCreate relationships
fromRequiredOnCreate: {
relType: {
serviceTag:"aa",
relationshipTag:"bb"
},
// or
belongToObjType: true, // if set to true use the belongTo relationship to belongTo objType

fieldName:"" // optional default= same field name eg: now default == xxx if not defined(use fieldname of object inside link when create)
}
},
// ...
},
compositeKeyDeliminator: "xx", // join partitionKey and sortKey
identifiers: [
// for dynamoDB storageType
{
type: "partitionKey",

fieldNames: ["xx","yy"], // composite partition keys in DynamoDB
deliminator: "xx", // optional, defaults to "_"
name: "zz", // name of field in database
// or
fieldName: "xx"

},
{
type: "sortKey",

fieldNames: ["xx","yy"], // composite partition keys in DynamoDB
deliminator: "xx", // optional, defaults to "_"
name: "zz", // name of field in database
// or
fieldName: "xx"

},

// for graph storageType
{
type: "identifier",
fieldNames: ["xx","yy"], // identifier field in graph or composite partition keys in DynamoDB
name: "zzz" // use when save in dynamoDB partitionKey
deliminator: "xx", // optional, defaults to "_"
// or
fieldName: "xx"
},
]
}
</syntaxhighlight>

== extendObjType ==

<syntaxhighlight lang="javascript">
{
// for objects stored in graph this will add another node label
objectType: "xx", // new label to add
extendObjType: { // core object that this object extends
serviceTag: "xxx",
objectType: "xxx"
},
addOnDataStructure: [],
storageResources:{ // these are the storageResources that carry the extended objects settings,
// (see above)
},
fieldNames: {
// (see above)
},
// canDelete/identifiers come from the core object
}
</syntaxhighlight>

== searchResultGenerated ==

* must be created by flow
* eg: variantProduct
* not have any storageResources
* identifiers are automatically searchResultData identifiers
* a searchResult request for this object will enter the searchResultGeneratedFlowType flow which creates searchResultData that can then be queried/sorted
* all relationships must be storageType = lambda, eg translate from variantProduct to variant uses a translateId flow to query the variantProduct identifier (searchResultData) to find the variantId in it's requiredData results
* searchResultGeneratedFlowType takes over after creating searchResultMain record until processRequiredData
* if objectSchema defines any fieldnames, then they are found using a flow, maybe as hooks in per service findData
* when finding direct fieldname, will need to check if requireData already exists, if not enter flow/findData to create
* no fields can be edited, so can show in forms but no updates performed

= Relationships Schema | ObjectRelationships.js =

* stored in top level schemas folder
* parent/child determines relationship direction for graph relationships
* have one service that contains information of each relationship

<syntaxhighlight lang="javascript">
// relationship schema in responsible service
[
{
"xxx": { // relationshipTag - name of relationship type stored in graph
generatedBy: "userGenerated" || "systemGenerated" // default="userGenerated"
canChangeToRelTypes: [
{
relType: { // relType that this relType can change to
serviceTag:"xxx",
relationshipTag: "yyy"
},
changeBy: "user" // "systemNoUserId" | "systemWithUserId" | "user", default="user"
}
// another relType
],
storageResources:{
"xxx":{ // storageResourceTag
storageType: "xx", // dynamoDB | graph | lambda
// if storageType="dynamoDB" will not specify tableName in relationship schema

// setting for storageType graph
graphServerTag: "xx",
additionalGraphIndexes:[['fieldName1', 'fieldName2', ...], [...]], // will make graph index with specific fieldName

// setting for storageType lambda
serviceTag: "xx",
functionName: "xx",
}
},
fieldNames: {
"xxx": { // relationship property name
type: "string", // "string" | "number" ...
requiredOnCreate: false, // default=false
optionalOnCreate: false, // default = false
updateBy: "user" // "systemNoUserId" | "systemWithUserId" | "user" | "none", default="user"
validation: {} // ajv syntax
},
//...other relationship properties
},
links: [
{
storageResourceTags: ["xxx"], // reference from storageResources property
canDelete: false // default = false, if set true will allow delete relationship between 2 objType
from: {
objType: {
serviceTag: "xx",
objectType: "xx"
},
requiredOnCreate: true, // if set true will create relationshipTag when create objType data, if both "from" and "to" linkType="many" should not have requiredOnCreate, exists in "from" or "to" only
linkType: "", // one | many
// moveBy: "none", // "systemNoUserId" | "systemWithUserId" | "user" | "none", default="none"
// belongTo:true
},
to: {
objType: {
serviceTag: "yy",
objectType: "yy"
},
linkType: "", // one | many
// moveBy allows the relationship to be moved between 2 instances of the same objType only
moveBy: "none", // "systemNoUserId" | "systemWithUserId" | "user" | "none", default="none"
belongTo:true, // false
},
requestProperties: {
// if storageType is Lambda and translateIds/linkPath requires properties set them here (eg sellOffer>orderPrice)
tag_deliverTo: {
requestPropertyType: "objectIdentifier",
objType: {
serviceTag: "Locations",
objectType: "locationNode" // deliversToLocationNode
},
identifiersFieldName: "locationNodeId"
},
// ... other request properties
}
}
// ...other link
]
}
}
]

</syntaxhighlight>

= Reference Relationships Schema | RefObjectRelationships.js =

<syntaxhighlight lang="javascript">
// reference to relationshipTag in external service
[
{
objectType: "zz", // objectType in local service
relationshipTag: "xxx", // name of relationshiptag of objType
relationshipServiceTag: "xx" // point to service tag that contain data of relationshipTag of objType
}
]

</syntaxhighlight>

= Flow Schema | FlowSchemas.js =

<syntaxhighlight lang="javascript">
[
{
flowTag: "yyy",
initiateBy:"user", // "user" | "system" -- if receive plugin should be user
handleObj:"one", // "one" | "multi"
statusType:"statusField", // "statusField" | "storedCache" | "none" | "triggerCache"

// statusType="triggerCache" setting
triggerType: "storedCache", // "storedCache" | "switch"
triggerFlowTypes:[
//... triggerFlowType
],

// statusType="statusField" | "triggerCache" | "storedCache" setting:
objType:{},

event:["ownTopic"], // "ownTopic" | "extTopic" | "s3" | "eventBridge" | "lambdaSyncInv" | "lambdaSyncApi" | "generatedCode"

// event="s3" setting
bucketName: "xxx", // bucket for s3 event
createBucket: boolean, // if true will generate new bucket with bucketName if false will point to old bucket that already have

// event="eventBridge" setting
schedules:[
{
name: 'your-scheduled-rate-event-name',
description: 'your scheduled rate event description',
rate: ["rate(1 minute)", ],
input:{}
}
],

// event="generatedCode" setting
generatedCodeConfig:{
generatedCodeTag: "create", // tag for generated code, eg "create" | "update" | "delete"
codeHookTag: "xx", // which codeHook to initiate flow from
// maybe validate: invocationType must exist in "event" array, so don't need to check 2 places when eg creating sns topic
invocationType: "ownTopic", // "ownTopic" | "lambdaSyncInv"

objType: {}, // which cases in the generated code trigger the flow
// .. other settings depending on generated code
}

outputTopic: boolean,

flowSteps:[
inTag:{ // will generate Topic serviceTag_stage_yyy_inTag
properties:[], // reference to stepProperties key, the first lambda's input properties and messageAttributes are the flow's input properties and messageAttributes
messageAttributes: [], // reference to stepProperties key
plugInHooks: [
{
plugInHookTag: "",
objType:{}, // used to query connection dynamo for an object instance in current flow
},
],
returnValues: [
properties:[], // reference to stepProperties key
messageAttributes: [], // reference to stepProperties key, only for outputTopic=true
],

},
// another flow steps
flowStep1:{ // will generate Topic serviceTag_stage_yyy_Flow1
properties:[], // reference to stepProperties key
messageAttributes: [] // reference to stepProperties key
event:["ownTopic"], // "ownTopic" | "extTopic" | "s3" | "eventBridge" | "lambdaSyncInv" | "lambdaSyncApi" | "generatedCode"
// handle splitting logic into awaitingStep/awaitingMultipleSteps
// handle splitting logic into paginated lambda

plugInHooks: [
{
plugInHookTag: "",
objType:{}, // used to query connection dynamo for an object instance in current flow
},
],
returnValues: [ // the last lambda function returnValues are the flow's returnValues
properties:[], // reference to stepProperties key
messageAttributes: [], // reference to stepProperties key, only for outputTopic=true
],

},
]

stepProperties:{ // normalized all stepProperties
"uuid":{
propertyName:"xxx",
type:"object",
required:false, // true | false default=false
childProperties:["uuid2", "uuid3"]
},
"uuid2":{
propertyName:"xxx",
required:false, // true | false default=false
type:"string",
},
"uuid3":{
propertyName:"xxx",
required:false, // true | false default=false
type:"string",
},
"uuid4":{
required:false, // true | false default=false
objectField:{
objType:{},
fieldName:"xx"
},
overwritePropertyName:"xx" // optional, if have objectField and have overwritePropertyName will overwrite fieldName
}
},
stepMessageAttributes:{ // normalized all stepMessageAttributes
"uuid":{
propertyName:"xxx",
required:false, // true | false default=false
type:"string",
},
"uuid2":{
propertyName:"yyy",
required:false, // true | false default=false
type:"string",
}
},
}
]
</syntaxhighlight>

= System Text Schema | SystemTextSchemas.js =

<syntaxhighlight lang="javascript">
[
{
namespace: "xxx", // groups files downloaded by frontend
systemTextTag: "yyy",
}
]
</syntaxhighlight>

== Auto generated systemText and namespaces ==

=== systemNotification names ===

* namespace: "sysNotification_{notificationGrouping}"
* systemTextTag: "{notificationTag}"
* eg shown on notification settings page

=== objType names ===

* namespace: "objTypes"
* systemTextTag: "{serviceTag}_{objectType}"
* eg shown on config pages, eg pulldown list of object types

=== objType field name descriptions ===

* namespace: "objType_fielddesc_{serviceTag}_{objectType}"
* systemTextTag: "{fieldname}"
* eg shown on config pages, eg info box for each field name

= System Notification Schema | SystemNotificationSchemas.js =

<syntaxhighlight lang="javascript">
[
{
notificationTag: "xxx",
notificationGrouping: "yyy",
weight: "##",
},
]
</syntaxhighlight>

= Generated S3 files =

* generate multiple files for different uses, eg:
*# list of saved fieldNames for Create
*# list of saved+calculated for Update/Info pages
*# graphSchemas
*# relationships (used by Search/Sort Results)

= Use Cases =

== Find Deployed Service Name ==

* other services can use fixed serviceTag to get deployed serviceName from serviceSchema on S3
* used to build resource names for external services
* eg when one service needs to send a message into an SNS belonging to a different service

== Standard Create, Update, List, Delete pages ==

* List and Delete are maybe not required, use table data system instead.
* object schema can add validation information that can be used on the frontend to check before sending to backend, and by the backend to validate the data before handling

=== Create Object ===

* can configure what fields are shown
* requiredOnCreate fields must be shown

=== Edit Object ===

* users setup any number of pages for object types with configurable fields shown
* fields can be either display only or edit
* each field can adjust it's display properties (perhaps via cssStyles)

== Menu Config ==

When adding menu items can add links to create, update, list, delete objects, user chooses the service then from that service's list of objects and what action is being performed. For update/delete perhaps links to a standard page that asks for the identifier before presenting the page.

== Tabled Data ==

When viewing tabled data the frontend pulls the tableId's config from backend, then when requesting the data also requests the serviceTag > objectType schema for use when displaying the data.

== Code Standardization ==

Code such as middleware validation schema and saving data to databases can be standardized.

== Code Generation ==

Endpoints per object for actions such as Create/Delete/Update can be automatically generated from objectSchema.

=== Code Generation Structure ===

* npm for generic code generation, can be used in any project, includes functions for generating Source files from templates and developer files
* npm for per project specific files, eg templates for the project (Create/Update/.. code)
* Empty Service Template has GenerateCode.js script file in root dir that is run to generate code, it invokes a generation function from generic npm with param that points to per project npm's templates
* generated Source retains hook tags (and any developer added code), so if developer wants to update developer's file with updated template code they can generate code and simply copy generated Source to src folder

= Graph Server Config =

* S3 has a list of graphServerTag's linking to the GraphHandler serviceTag responsible for the graph
* multiple graphServerTags can point to one GraphHandler, combining graphs into one server
* when creating each GraphHandler's graph schemas, for each field split out the fields into each GraphHandler using the graphServerTag, if multiple graphServerTags for a field point to the same GraphHandler combine the fields to create GraphHandler's graph schema
* every GraphHandler an object is saved into will require it's identifiers
* when eg updating fields for an object separate the fields per GraphHandler before sending the request to update each graph

= Extended Object Types =

* Allows for one graph node to have multiple labels
* graph schema is created for both the core object and the extended object
* eg Media Manager's has a node schema for "media" object type, and Image service has a node schema for "image" object type
* the extended object builds it's schema by combining core + extended settings

= Working documents =

[[:Category:Working_documents - Per Service Schemas|Per Service Schemas]]

Per Service Schemas

2026-07-14T07:08:45Z

Seagame: /* Flow Schema | FlowSchemas.js */

= Overview =

Each service manages a schema of object/resources that it is responsible for, this schema is available to other services and frontends. The schema includes a list of fields available for each object.

= File Structure =

* see [[Repository structure#schemas|Repository structure]]

= ObjectSchema | ObjectFieldSchema.js =

== Not extendObjType ==

<syntaxhighlight lang="javascript">
{
objectType: "xx",
shortNameObjectType:"x", // optional, use when generate code create lambda role with long name
canDelete: false, // whether any fields can be deleted // default = false
belongTo: {
serviceTag:"iii",
objectType:"jjj"
},
// how is the object created
// userGenerated there will be generated endpoints for api or sqs (used in importBatchMain) to create object
// systemGenerated must be created by flow/s
// searchResultGenerated see separate notes below
generatedBy: "userGenerated" || "systemGenerated" || "searchResultGenerated" // required
searchResultGeneratedFlowType: {}, // for generatedBy = searchResultGenerated
addOnDataStructure: [ // optional, add for additional setting to objectType
{
// all fields that a user can edit must be in versionedData, and all fields in versionedData must be editable by user
type:"versionedData",
versionedDataLabel: "xx", // versionedData label name
storageResourceTag : "xx", // ref to storegeResourceTag
fieldNames: { // fieldName in versionedData cannot have in in main objectSchema.fieldNames
"aaa":{ // fieldName
type: "xx", // string|integer|number|timestamp|currency|currencyValue|float|special|object|boolean|arrayMixed|arrayNumeric|arrayString
requiredOnCreate: false, // default = false
optionalOnCreate: false, // default = false,
validation: {
itemValidation:{} // for validate item in array
},
// probably impossible to have fromObjType, because data can be changed by user here
fromObjType:{
serviceTag: "xxx",
objectType: "xxx"
},
},
// ...
}
},
{ // can have multiple addOn of type attributeTree
type:"attributeTree",
},
{
type:"translation"
},
{
type:"propertyValue"
},
{
type:"mediaLink"
},
{
type:"rbac"
},
// ...
],
plugInTags: ["a", "b"], // plugIns that can be connected to this objType
storageResources:{
"xxx":{ // storageResourceTag
storageType: "xx", // graph
graphServerTag: "xx", // setting for storageType graph
additionalGraphIndexes:[['fieldName1', 'fieldName2', ...], [...]] // will make graph index with specific fieldName
},
"zzz":{ // storageResourceTag
storageType: "xx", // dynamoDB
// setting for storageType dynamoDB
tableName: "xx",
groupByPartitionKeyField: "xx", // use groupByPartitionKeyField as partition key and not have sort key in dynamoDB, if have multiple identifiers will concat it. And use it as partitionKey.
serviceTag:"zz"// default own service.
}
},
fieldNames: {
xxx: { // fieldName
type: "xx", // string|integer|number|timestamp|currency|currencyValue|float|special|object|boolean|arrayMixed|arrayNumeric|arrayString
randomOnCreate: false, // default = false , can set true in fieldName that part of identifiers and identifiers have single identifierFieldname
requiredOnCreate: false, // default = false
optionalOnCreate: false, // default = false
canUpdate: true, // default = true (only system/flows can edit, no history of changes unless flow manually adds)
validation: {
itemValidation:{} // for validate item in array
}, // maybe ajv syntax
storageResourceTags: ["xx","yy"], // reference to storageResources property
fromObjType:{
serviceTag: "xxx",
objectType: "xxx"
},
hashOnCreate: ["xx", "yy"], // reference to other fieldName,
statusField: true, // use for objectSchema inside flowSchema, identify which field is statusField

// comes from requiredOnCreate relationships
fromRequiredOnCreate: {
relType: {
serviceTag:"aa",
relationshipTag:"bb"
},
// or
belongToObjType: true, // if set to true use the belongTo relationship to belongTo objType

fieldName:"" // optional default= same field name eg: now default == xxx if not defined(use fieldname of object inside link when create)
}
},
// ...
},
compositeKeyDeliminator: "xx", // join partitionKey and sortKey
identifiers: [
// for dynamoDB storageType
{
type: "partitionKey",

fieldNames: ["xx","yy"], // composite partition keys in DynamoDB
deliminator: "xx", // optional, defaults to "_"
name: "zz", // name of field in database
// or
fieldName: "xx"

},
{
type: "sortKey",

fieldNames: ["xx","yy"], // composite partition keys in DynamoDB
deliminator: "xx", // optional, defaults to "_"
name: "zz", // name of field in database
// or
fieldName: "xx"

},

// for graph storageType
{
type: "identifier",
fieldNames: ["xx","yy"], // identifier field in graph or composite partition keys in DynamoDB
name: "zzz" // use when save in dynamoDB partitionKey
deliminator: "xx", // optional, defaults to "_"
// or
fieldName: "xx"
},
]
}
</syntaxhighlight>

== extendObjType ==

<syntaxhighlight lang="javascript">
{
// for objects stored in graph this will add another node label
objectType: "xx", // new label to add
extendObjType: { // core object that this object extends
serviceTag: "xxx",
objectType: "xxx"
},
addOnDataStructure: [],
storageResources:{ // these are the storageResources that carry the extended objects settings,
// (see above)
},
fieldNames: {
// (see above)
},
// canDelete/identifiers come from the core object
}
</syntaxhighlight>

== searchResultGenerated ==

* must be created by flow
* eg: variantProduct
* not have any storageResources
* identifiers are automatically searchResultData identifiers
* a searchResult request for this object will enter the searchResultGeneratedFlowType flow which creates searchResultData that can then be queried/sorted
* all relationships must be storageType = lambda, eg translate from variantProduct to variant uses a translateId flow to query the variantProduct identifier (searchResultData) to find the variantId in it's requiredData results
* searchResultGeneratedFlowType takes over after creating searchResultMain record until processRequiredData
* if objectSchema defines any fieldnames, then they are found using a flow, maybe as hooks in per service findData
* when finding direct fieldname, will need to check if requireData already exists, if not enter flow/findData to create
* no fields can be edited, so can show in forms but no updates performed

= Relationships Schema | ObjectRelationships.js =

* stored in top level schemas folder
* parent/child determines relationship direction for graph relationships
* have one service that contains information of each relationship

<syntaxhighlight lang="javascript">
// relationship schema in responsible service
[
{
"xxx": { // relationshipTag - name of relationship type stored in graph
generatedBy: "userGenerated" || "systemGenerated" // default="userGenerated"
canChangeToRelTypes: [
{
relType: { // relType that this relType can change to
serviceTag:"xxx",
relationshipTag: "yyy"
},
changeBy: "user" // "systemNoUserId" | "systemWithUserId" | "user", default="user"
}
// another relType
],
storageResources:{
"xxx":{ // storageResourceTag
storageType: "xx", // dynamoDB | graph | lambda
// if storageType="dynamoDB" will not specify tableName in relationship schema

// setting for storageType graph
graphServerTag: "xx",
additionalGraphIndexes:[['fieldName1', 'fieldName2', ...], [...]], // will make graph index with specific fieldName

// setting for storageType lambda
serviceTag: "xx",
functionName: "xx",
}
},
fieldNames: {
"xxx": { // relationship property name
type: "string", // "string" | "number" ...
requiredOnCreate: false, // default=false
optionalOnCreate: false, // default = false
updateBy: "user" // "systemNoUserId" | "systemWithUserId" | "user" | "none", default="user"
validation: {} // ajv syntax
},
//...other relationship properties
},
links: [
{
storageResourceTags: ["xxx"], // reference from storageResources property
canDelete: false // default = false, if set true will allow delete relationship between 2 objType
from: {
objType: {
serviceTag: "xx",
objectType: "xx"
},
requiredOnCreate: true, // if set true will create relationshipTag when create objType data, if both "from" and "to" linkType="many" should not have requiredOnCreate, exists in "from" or "to" only
linkType: "", // one | many
// moveBy: "none", // "systemNoUserId" | "systemWithUserId" | "user" | "none", default="none"
// belongTo:true
},
to: {
objType: {
serviceTag: "yy",
objectType: "yy"
},
linkType: "", // one | many
// moveBy allows the relationship to be moved between 2 instances of the same objType only
moveBy: "none", // "systemNoUserId" | "systemWithUserId" | "user" | "none", default="none"
belongTo:true, // false
},
requestProperties: {
// if storageType is Lambda and translateIds/linkPath requires properties set them here (eg sellOffer>orderPrice)
tag_deliverTo: {
requestPropertyType: "objectIdentifier",
objType: {
serviceTag: "Locations",
objectType: "locationNode" // deliversToLocationNode
},
identifiersFieldName: "locationNodeId"
},
// ... other request properties
}
}
// ...other link
]
}
}
]

</syntaxhighlight>

= Reference Relationships Schema | RefObjectRelationships.js =

<syntaxhighlight lang="javascript">
// reference to relationshipTag in external service
[
{
objectType: "zz", // objectType in local service
relationshipTag: "xxx", // name of relationshiptag of objType
relationshipServiceTag: "xx" // point to service tag that contain data of relationshipTag of objType
}
]

</syntaxhighlight>

= Flow Schema | FlowSchemas.js =

<syntaxhighlight lang="javascript">
[
{
flowTag: "yyy",
initiateBy:"user", // "user" | "system" -- if receive plugin should be user
handleObj:"one", // "one" | "multi"
statusType:"statusField", // "statusField" | "storedCache" | "none" | "triggerCache"

// statusType="triggerCache" setting
triggerType: "storedCache", // "storedCache" | "switch"
triggerFlowTypes:[
//... triggerFlowType
],

// statusType="statusField" | "triggerCache" | "storedCache" setting:
objType:{},

event:["ownTopic"], // "ownTopic" | "extTopic" | "s3" | "eventBridge" | "lambdaSyncInv" | "lambdaSyncApi" | "generatedCode"

// event="s3" setting
bucketName: "xxx", // bucket for s3 event
createBucket: boolean, // if true will generate new bucket with bucketName if false will point to old bucket that already have

// event="eventBridge" setting
schedules:[
{
name: 'your-scheduled-rate-event-name',
description: 'your scheduled rate event description',
rate: ["rate(1 minute)", ],
input:{}
}
],

// event="generatedCode" setting
generatedCodeConfig:{
generatedCodeTag: "create", // tag for generated code, eg "create" | "update" | "delete"
codeHookTag: "xx", // which codeHook to initiate flow from
// maybe validate: invocationType must exist in "event" array, so don't need to check 2 places when eg creating sns topic
invocationType: "ownTopic", // "ownTopic" | "lambdaSyncInv"

objType: {}, // which cases in the generated code trigger the flow
// .. other settings depending on generated code
}

outputTopic: boolean,

flowSteps:[
inTag:{ // will generate Topic serviceTag_stage_yyy_inTag
properties:[], // reference to stepProperties key, the first lambda's input properties and messageAttributes are the flow's input properties and messageAttributes
messageAttributes: [], // reference to stepProperties key
plugInHooks: [
{
plugInHookTag: "",
objType:{}, // used to query connection dynamo for an object instance in current flow
},
],
returnValues: [
properties:[], // reference to stepProperties key
messageAttributes: [], // reference to stepProperties key, only for outputTopic=true
],

},
// another flow steps
flowStep1:{ // will generate Topic serviceTag_stage_yyy_Flow1
properties:[], // reference to stepProperties key
messageAttributes: [] // reference to stepProperties key
event:["ownTopic"], // "ownTopic" | "extTopic" | "s3" | "eventBridge" | "lambdaSyncInv" | "lambdaSyncApi" | "generatedCode"
// handle splitting logic into awaitingStep/awaitingMultipleSteps
// handle splitting logic into paginated lambda

plugInHooks: [
{
plugInHookTag: "",
objType:{}, // used to query connection dynamo for an object instance in current flow
},
],
returnValues: [ // the last lambda function returnValues are the flow's returnValues
properties:[], // reference to stepProperties key
messageAttributes: [], // reference to stepProperties key, only for outputTopic=true
],

},
]

stepProperties:{ // normalized all stepProperties
"uuid":{
propertyName:"xxx",
type:"object",
childProperties:["uuid2", "uuid3"]
},
"uuid2":{
propertyName:"xxx",
type:"string",
},
"uuid3":{
propertyName:"xxx",
type:"string",
},
"uuid4":{
objectField:{
objType:{},
fieldName:"xx"
},
overwritePropertyName:"xx" // optional, if have objectField and have overwritePropertyName will overwrite fieldName
}
},
stepMessageAttributes:{ // normalized all stepMessageAttributes
"uuid":{
propertyName:"xxx",
type:"string",
},
"uuid2":{
propertyName:"yyy",
type:"string",
}
},
}
]
</syntaxhighlight>

= System Text Schema | SystemTextSchemas.js =

<syntaxhighlight lang="javascript">
[
{
namespace: "xxx", // groups files downloaded by frontend
systemTextTag: "yyy",
}
]
</syntaxhighlight>

== Auto generated systemText and namespaces ==

=== systemNotification names ===

* namespace: "sysNotification_{notificationGrouping}"
* systemTextTag: "{notificationTag}"
* eg shown on notification settings page

=== objType names ===

* namespace: "objTypes"
* systemTextTag: "{serviceTag}_{objectType}"
* eg shown on config pages, eg pulldown list of object types

=== objType field name descriptions ===

* namespace: "objType_fielddesc_{serviceTag}_{objectType}"
* systemTextTag: "{fieldname}"
* eg shown on config pages, eg info box for each field name

= System Notification Schema | SystemNotificationSchemas.js =

<syntaxhighlight lang="javascript">
[
{
notificationTag: "xxx",
notificationGrouping: "yyy",
weight: "##",
},
]
</syntaxhighlight>

= Generated S3 files =

* generate multiple files for different uses, eg:
*# list of saved fieldNames for Create
*# list of saved+calculated for Update/Info pages
*# graphSchemas
*# relationships (used by Search/Sort Results)

= Use Cases =

== Find Deployed Service Name ==

* other services can use fixed serviceTag to get deployed serviceName from serviceSchema on S3
* used to build resource names for external services
* eg when one service needs to send a message into an SNS belonging to a different service

== Standard Create, Update, List, Delete pages ==

* List and Delete are maybe not required, use table data system instead.
* object schema can add validation information that can be used on the frontend to check before sending to backend, and by the backend to validate the data before handling

=== Create Object ===

* can configure what fields are shown
* requiredOnCreate fields must be shown

=== Edit Object ===

* users setup any number of pages for object types with configurable fields shown
* fields can be either display only or edit
* each field can adjust it's display properties (perhaps via cssStyles)

== Menu Config ==

When adding menu items can add links to create, update, list, delete objects, user chooses the service then from that service's list of objects and what action is being performed. For update/delete perhaps links to a standard page that asks for the identifier before presenting the page.

== Tabled Data ==

When viewing tabled data the frontend pulls the tableId's config from backend, then when requesting the data also requests the serviceTag > objectType schema for use when displaying the data.

== Code Standardization ==

Code such as middleware validation schema and saving data to databases can be standardized.

== Code Generation ==

Endpoints per object for actions such as Create/Delete/Update can be automatically generated from objectSchema.

=== Code Generation Structure ===

* npm for generic code generation, can be used in any project, includes functions for generating Source files from templates and developer files
* npm for per project specific files, eg templates for the project (Create/Update/.. code)
* Empty Service Template has GenerateCode.js script file in root dir that is run to generate code, it invokes a generation function from generic npm with param that points to per project npm's templates
* generated Source retains hook tags (and any developer added code), so if developer wants to update developer's file with updated template code they can generate code and simply copy generated Source to src folder

= Graph Server Config =

* S3 has a list of graphServerTag's linking to the GraphHandler serviceTag responsible for the graph
* multiple graphServerTags can point to one GraphHandler, combining graphs into one server
* when creating each GraphHandler's graph schemas, for each field split out the fields into each GraphHandler using the graphServerTag, if multiple graphServerTags for a field point to the same GraphHandler combine the fields to create GraphHandler's graph schema
* every GraphHandler an object is saved into will require it's identifiers
* when eg updating fields for an object separate the fields per GraphHandler before sending the request to update each graph

= Extended Object Types =

* Allows for one graph node to have multiple labels
* graph schema is created for both the core object and the extended object
* eg Media Manager's has a node schema for "media" object type, and Image service has a node schema for "image" object type
* the extended object builds it's schema by combining core + extended settings

= Working documents =

[[:Category:Working_documents - Per Service Schemas|Per Service Schemas]]

Per Service Schemas

2026-07-08T01:27:34Z

Seagame: /* Relationships Schema | ObjectRelationships.js */

= Overview =

Each service manages a schema of object/resources that it is responsible for, this schema is available to other services and frontends. The schema includes a list of fields available for each object.

= File Structure =

* see [[Repository structure#schemas|Repository structure]]

= ObjectSchema | ObjectFieldSchema.js =

== Not extendObjType ==

<syntaxhighlight lang="javascript">
{
objectType: "xx",
shortNameObjectType:"x", // optional, use when generate code create lambda role with long name
canDelete: false, // whether any fields can be deleted // default = false
belongTo: {
serviceTag:"iii",
objectType:"jjj"
},
// how is the object created
// userGenerated there will be generated endpoints for api or sqs (used in importBatchMain) to create object
// systemGenerated must be created by flow/s
// searchResultGenerated see separate notes below
generatedBy: "userGenerated" || "systemGenerated" || "searchResultGenerated" // required
searchResultGeneratedFlowType: {}, // for generatedBy = searchResultGenerated
addOnDataStructure: [ // optional, add for additional setting to objectType
{
// all fields that a user can edit must be in versionedData, and all fields in versionedData must be editable by user
type:"versionedData",
versionedDataLabel: "xx", // versionedData label name
storageResourceTag : "xx", // ref to storegeResourceTag
fieldNames: { // fieldName in versionedData cannot have in in main objectSchema.fieldNames
"aaa":{ // fieldName
type: "xx", // string|integer|number|timestamp|currency|currencyValue|float|special|object|boolean|arrayMixed|arrayNumeric|arrayString
requiredOnCreate: false, // default = false
optionalOnCreate: false, // default = false,
validation: {
itemValidation:{} // for validate item in array
},
// probably impossible to have fromObjType, because data can be changed by user here
fromObjType:{
serviceTag: "xxx",
objectType: "xxx"
},
},
// ...
}
},
{ // can have multiple addOn of type attributeTree
type:"attributeTree",
},
{
type:"translation"
},
{
type:"propertyValue"
},
{
type:"mediaLink"
},
{
type:"rbac"
},
// ...
],
plugInTags: ["a", "b"], // plugIns that can be connected to this objType
storageResources:{
"xxx":{ // storageResourceTag
storageType: "xx", // graph
graphServerTag: "xx", // setting for storageType graph
additionalGraphIndexes:[['fieldName1', 'fieldName2', ...], [...]] // will make graph index with specific fieldName
},
"zzz":{ // storageResourceTag
storageType: "xx", // dynamoDB
// setting for storageType dynamoDB
tableName: "xx",
groupByPartitionKeyField: "xx", // use groupByPartitionKeyField as partition key and not have sort key in dynamoDB, if have multiple identifiers will concat it. And use it as partitionKey.
serviceTag:"zz"// default own service.
}
},
fieldNames: {
xxx: { // fieldName
type: "xx", // string|integer|number|timestamp|currency|currencyValue|float|special|object|boolean|arrayMixed|arrayNumeric|arrayString
randomOnCreate: false, // default = false , can set true in fieldName that part of identifiers and identifiers have single identifierFieldname
requiredOnCreate: false, // default = false
optionalOnCreate: false, // default = false
canUpdate: true, // default = true (only system/flows can edit, no history of changes unless flow manually adds)
validation: {
itemValidation:{} // for validate item in array
}, // maybe ajv syntax
storageResourceTags: ["xx","yy"], // reference to storageResources property
fromObjType:{
serviceTag: "xxx",
objectType: "xxx"
},
hashOnCreate: ["xx", "yy"], // reference to other fieldName,
statusField: true, // use for objectSchema inside flowSchema, identify which field is statusField

// comes from requiredOnCreate relationships
fromRequiredOnCreate: {
relType: {
serviceTag:"aa",
relationshipTag:"bb"
},
// or
belongToObjType: true, // if set to true use the belongTo relationship to belongTo objType

fieldName:"" // optional default= same field name eg: now default == xxx if not defined(use fieldname of object inside link when create)
}
},
// ...
},
compositeKeyDeliminator: "xx", // join partitionKey and sortKey
identifiers: [
// for dynamoDB storageType
{
type: "partitionKey",

fieldNames: ["xx","yy"], // composite partition keys in DynamoDB
deliminator: "xx", // optional, defaults to "_"
name: "zz", // name of field in database
// or
fieldName: "xx"

},
{
type: "sortKey",

fieldNames: ["xx","yy"], // composite partition keys in DynamoDB
deliminator: "xx", // optional, defaults to "_"
name: "zz", // name of field in database
// or
fieldName: "xx"

},

// for graph storageType
{
type: "identifier",
fieldNames: ["xx","yy"], // identifier field in graph or composite partition keys in DynamoDB
name: "zzz" // use when save in dynamoDB partitionKey
deliminator: "xx", // optional, defaults to "_"
// or
fieldName: "xx"
},
]
}
</syntaxhighlight>

== extendObjType ==

<syntaxhighlight lang="javascript">
{
// for objects stored in graph this will add another node label
objectType: "xx", // new label to add
extendObjType: { // core object that this object extends
serviceTag: "xxx",
objectType: "xxx"
},
addOnDataStructure: [],
storageResources:{ // these are the storageResources that carry the extended objects settings,
// (see above)
},
fieldNames: {
// (see above)
},
// canDelete/identifiers come from the core object
}
</syntaxhighlight>

== searchResultGenerated ==

* must be created by flow
* eg: variantProduct
* not have any storageResources
* identifiers are automatically searchResultData identifiers
* a searchResult request for this object will enter the searchResultGeneratedFlowType flow which creates searchResultData that can then be queried/sorted
* all relationships must be storageType = lambda, eg translate from variantProduct to variant uses a translateId flow to query the variantProduct identifier (searchResultData) to find the variantId in it's requiredData results
* searchResultGeneratedFlowType takes over after creating searchResultMain record until processRequiredData
* if objectSchema defines any fieldnames, then they are found using a flow, maybe as hooks in per service findData
* when finding direct fieldname, will need to check if requireData already exists, if not enter flow/findData to create
* no fields can be edited, so can show in forms but no updates performed

= Relationships Schema | ObjectRelationships.js =

* stored in top level schemas folder
* parent/child determines relationship direction for graph relationships
* have one service that contains information of each relationship

<syntaxhighlight lang="javascript">
// relationship schema in responsible service
[
{
"xxx": { // relationshipTag - name of relationship type stored in graph
generatedBy: "userGenerated" || "systemGenerated" // default="userGenerated"
canChangeToRelTypes: [
{
relType: { // relType that this relType can change to
serviceTag:"xxx",
relationshipTag: "yyy"
},
changeBy: "user" // "systemNoUserId" | "systemWithUserId" | "user", default="user"
}
// another relType
],
storageResources:{
"xxx":{ // storageResourceTag
storageType: "xx", // dynamoDB | graph | lambda
// if storageType="dynamoDB" will not specify tableName in relationship schema

// setting for storageType graph
graphServerTag: "xx",
additionalGraphIndexes:[['fieldName1', 'fieldName2', ...], [...]], // will make graph index with specific fieldName

// setting for storageType lambda
serviceTag: "xx",
functionName: "xx",
}
},
fieldNames: {
"xxx": { // relationship property name
type: "string", // "string" | "number" ...
requiredOnCreate: false, // default=false
optionalOnCreate: false, // default = false
updateBy: "user" // "systemNoUserId" | "systemWithUserId" | "user" | "none", default="user"
validation: {} // ajv syntax
},
//...other relationship properties
},
links: [
{
storageResourceTags: ["xxx"], // reference from storageResources property
canDelete: false // default = false, if set true will allow delete relationship between 2 objType
from: {
objType: {
serviceTag: "xx",
objectType: "xx"
},
requiredOnCreate: true, // if set true will create relationshipTag when create objType data, if both "from" and "to" linkType="many" should not have requiredOnCreate, exists in "from" or "to" only
linkType: "", // one | many
// moveBy: "none", // "systemNoUserId" | "systemWithUserId" | "user" | "none", default="none"
// belongTo:true
},
to: {
objType: {
serviceTag: "yy",
objectType: "yy"
},
linkType: "", // one | many
// moveBy allows the relationship to be moved between 2 instances of the same objType only
moveBy: "none", // "systemNoUserId" | "systemWithUserId" | "user" | "none", default="none"
belongTo:true, // false
},
requestProperties: {
// if storageType is Lambda and translateIds/linkPath requires properties set them here (eg sellOffer>orderPrice)
tag_deliverTo: {
requestPropertyType: "objectIdentifier",
objType: {
serviceTag: "Locations",
objectType: "locationNode" // deliversToLocationNode
},
identifiersFieldName: "locationNodeId"
},
// ... other request properties
}
}
// ...other link
]
}
}
]

</syntaxhighlight>

= Reference Relationships Schema | RefObjectRelationships.js =

<syntaxhighlight lang="javascript">
// reference to relationshipTag in external service
[
{
objectType: "zz", // objectType in local service
relationshipTag: "xxx", // name of relationshiptag of objType
relationshipServiceTag: "xx" // point to service tag that contain data of relationshipTag of objType
}
]

</syntaxhighlight>

= Flow Schema | FlowSchemas.js =

<syntaxhighlight lang="javascript">
[
{
flowTag: "yyy",
initiateBy:"user", // "user" | "system" -- if receive plugin should be user
handleObj:"one", // "one" | "multi"
statusType:"statusField", // "statusField" | "storedCache" | "none" | "triggerCache"

// statusType="triggerCache" setting
triggerType: "storedCache", // "storedCache" | "switch"
triggerFlowTypes:[
//... triggerFlowType
],

// statusType="statusField" | "triggerCache" | "storedCache" setting:
objType:{},

event:["ownTopic"], // "ownTopic" | "extTopic" | "s3" | "eventBridge" | "lambdaSyncInv" | "lambdaSyncApi" | "generatedCode"

// event="s3" setting
bucketName: "xxx", // bucket for s3 event
createBucket: boolean, // if true will generate new bucket with bucketName if false will point to old bucket that already have

// event="eventBridge" setting
schedules:[
{
name: 'your-scheduled-rate-event-name',
description: 'your scheduled rate event description',
rate: ["rate(1 minute)", ],
input:{}
}
],

// event="generatedCode" setting
generatedCodeConfig:{
generatedCodeTag: "create", // tag for generated code, eg "create" | "update" | "delete"
codeHookTag: "xx", // which codeHook to initiate flow from
// maybe validate: invocationType must exist in "event" array, so don't need to check 2 places when eg creating sns topic
invocationType: "ownTopic", // "ownTopic" | "lambdaSyncInv"

objType: {}, // which cases in the generated code trigger the flow
// .. other settings depending on generated code
}

outputTopic: boolean,

flowSteps:[
inTag:{ // will generate Topic serviceTag_stage_yyy_inTag
properties:[], // reference to stepProperties key, the first lambda's input properties and messageAttributes are the flow's input properties and messageAttributes
messageAttributes: [], // reference to stepProperties key
plugInHooks: [
{
plugInHookTag: "",
objType:{}, // used to query connection dynamo for an object instance in current flow
},
],
returnValues: [
properties:[], // reference to stepProperties key
messageAttributes: [], // reference to stepProperties key, only for outputTopic=true
],

},
// another flow steps
flowStep1:{ // will generate Topic serviceTag_stage_yyy_Flow1
properties:[], // reference to stepProperties key
messageAttributes: [] // reference to stepProperties key
event:["ownTopic"], // "ownTopic" | "extTopic" | "s3" | "eventBridge" | "lambdaSyncInv" | "lambdaSyncApi" | "generatedCode"
// handle splitting logic into awaitingStep/awaitingMultipleSteps
// handle splitting logic into paginated lambda

plugInHooks: [
{
plugInHookTag: "",
objType:{}, // used to query connection dynamo for an object instance in current flow
},
],
returnValues: [ // the last lambda function returnValues are the flow's returnValues
properties:[], // reference to stepProperties key
messageAttributes: [], // reference to stepProperties key, only for outputTopic=true
],

},
]

stepProperties:{ // normalized all stepProperties
"uuid":{
propertyName:"xxx",
type:"string",
},
"uuid2":{
objectField:{
objType:{},
fieldName:"xx"
},
overwritePropertyName:"xx" // optional, if have objectField and have overwritePropertyName will overwrite fieldName
}
},
stepMessageAttributes:{ // normalized all stepMessageAttributes
"uuid":{
propertyName:"xxx",
type:"string",
},
"uuid2":{
propertyName:"yyy",
type:"string",
}
},
}
]
</syntaxhighlight>

= System Text Schema | SystemTextSchemas.js =

<syntaxhighlight lang="javascript">
[
{
namespace: "xxx", // groups files downloaded by frontend
systemTextTag: "yyy",
}
]
</syntaxhighlight>

== Auto generated systemText and namespaces ==

=== systemNotification names ===

* namespace: "sysNotification_{notificationGrouping}"
* systemTextTag: "{notificationTag}"
* eg shown on notification settings page

=== objType names ===

* namespace: "objTypes"
* systemTextTag: "{serviceTag}_{objectType}"
* eg shown on config pages, eg pulldown list of object types

=== objType field name descriptions ===

* namespace: "objType_fielddesc_{serviceTag}_{objectType}"
* systemTextTag: "{fieldname}"
* eg shown on config pages, eg info box for each field name

= System Notification Schema | SystemNotificationSchemas.js =

<syntaxhighlight lang="javascript">
[
{
notificationTag: "xxx",
notificationGrouping: "yyy",
weight: "##",
},
]
</syntaxhighlight>

= Generated S3 files =

* generate multiple files for different uses, eg:
*# list of saved fieldNames for Create
*# list of saved+calculated for Update/Info pages
*# graphSchemas
*# relationships (used by Search/Sort Results)

= Use Cases =

== Find Deployed Service Name ==

* other services can use fixed serviceTag to get deployed serviceName from serviceSchema on S3
* used to build resource names for external services
* eg when one service needs to send a message into an SNS belonging to a different service

== Standard Create, Update, List, Delete pages ==

* List and Delete are maybe not required, use table data system instead.
* object schema can add validation information that can be used on the frontend to check before sending to backend, and by the backend to validate the data before handling

=== Create Object ===

* can configure what fields are shown
* requiredOnCreate fields must be shown

=== Edit Object ===

* users setup any number of pages for object types with configurable fields shown
* fields can be either display only or edit
* each field can adjust it's display properties (perhaps via cssStyles)

== Menu Config ==

When adding menu items can add links to create, update, list, delete objects, user chooses the service then from that service's list of objects and what action is being performed. For update/delete perhaps links to a standard page that asks for the identifier before presenting the page.

== Tabled Data ==

When viewing tabled data the frontend pulls the tableId's config from backend, then when requesting the data also requests the serviceTag > objectType schema for use when displaying the data.

== Code Standardization ==

Code such as middleware validation schema and saving data to databases can be standardized.

== Code Generation ==

Endpoints per object for actions such as Create/Delete/Update can be automatically generated from objectSchema.

=== Code Generation Structure ===

* npm for generic code generation, can be used in any project, includes functions for generating Source files from templates and developer files
* npm for per project specific files, eg templates for the project (Create/Update/.. code)
* Empty Service Template has GenerateCode.js script file in root dir that is run to generate code, it invokes a generation function from generic npm with param that points to per project npm's templates
* generated Source retains hook tags (and any developer added code), so if developer wants to update developer's file with updated template code they can generate code and simply copy generated Source to src folder

= Graph Server Config =

* S3 has a list of graphServerTag's linking to the GraphHandler serviceTag responsible for the graph
* multiple graphServerTags can point to one GraphHandler, combining graphs into one server
* when creating each GraphHandler's graph schemas, for each field split out the fields into each GraphHandler using the graphServerTag, if multiple graphServerTags for a field point to the same GraphHandler combine the fields to create GraphHandler's graph schema
* every GraphHandler an object is saved into will require it's identifiers
* when eg updating fields for an object separate the fields per GraphHandler before sending the request to update each graph

= Extended Object Types =

* Allows for one graph node to have multiple labels
* graph schema is created for both the core object and the extended object
* eg Media Manager's has a node schema for "media" object type, and Image service has a node schema for "image" object type
* the extended object builds it's schema by combining core + extended settings

= Working documents =

[[:Category:Working_documents - Per Service Schemas|Per Service Schemas]]

Per Service Schemas

2026-07-08T01:06:11Z

Seagame: /* Relationships Schema | ObjectRelationships.js */

= Overview =

Each service manages a schema of object/resources that it is responsible for, this schema is available to other services and frontends. The schema includes a list of fields available for each object.

= File Structure =

* see [[Repository structure#schemas|Repository structure]]

= ObjectSchema | ObjectFieldSchema.js =

== Not extendObjType ==

<syntaxhighlight lang="javascript">
{
objectType: "xx",
shortNameObjectType:"x", // optional, use when generate code create lambda role with long name
canDelete: false, // whether any fields can be deleted // default = false
belongTo: {
serviceTag:"iii",
objectType:"jjj"
},
// how is the object created
// userGenerated there will be generated endpoints for api or sqs (used in importBatchMain) to create object
// systemGenerated must be created by flow/s
// searchResultGenerated see separate notes below
generatedBy: "userGenerated" || "systemGenerated" || "searchResultGenerated" // required
searchResultGeneratedFlowType: {}, // for generatedBy = searchResultGenerated
addOnDataStructure: [ // optional, add for additional setting to objectType
{
// all fields that a user can edit must be in versionedData, and all fields in versionedData must be editable by user
type:"versionedData",
versionedDataLabel: "xx", // versionedData label name
storageResourceTag : "xx", // ref to storegeResourceTag
fieldNames: { // fieldName in versionedData cannot have in in main objectSchema.fieldNames
"aaa":{ // fieldName
type: "xx", // string|integer|number|timestamp|currency|currencyValue|float|special|object|boolean|arrayMixed|arrayNumeric|arrayString
requiredOnCreate: false, // default = false
optionalOnCreate: false, // default = false,
validation: {
itemValidation:{} // for validate item in array
},
// probably impossible to have fromObjType, because data can be changed by user here
fromObjType:{
serviceTag: "xxx",
objectType: "xxx"
},
},
// ...
}
},
{ // can have multiple addOn of type attributeTree
type:"attributeTree",
},
{
type:"translation"
},
{
type:"propertyValue"
},
{
type:"mediaLink"
},
{
type:"rbac"
},
// ...
],
plugInTags: ["a", "b"], // plugIns that can be connected to this objType
storageResources:{
"xxx":{ // storageResourceTag
storageType: "xx", // graph
graphServerTag: "xx", // setting for storageType graph
additionalGraphIndexes:[['fieldName1', 'fieldName2', ...], [...]] // will make graph index with specific fieldName
},
"zzz":{ // storageResourceTag
storageType: "xx", // dynamoDB
// setting for storageType dynamoDB
tableName: "xx",
groupByPartitionKeyField: "xx", // use groupByPartitionKeyField as partition key and not have sort key in dynamoDB, if have multiple identifiers will concat it. And use it as partitionKey.
serviceTag:"zz"// default own service.
}
},
fieldNames: {
xxx: { // fieldName
type: "xx", // string|integer|number|timestamp|currency|currencyValue|float|special|object|boolean|arrayMixed|arrayNumeric|arrayString
randomOnCreate: false, // default = false , can set true in fieldName that part of identifiers and identifiers have single identifierFieldname
requiredOnCreate: false, // default = false
optionalOnCreate: false, // default = false
canUpdate: true, // default = true (only system/flows can edit, no history of changes unless flow manually adds)
validation: {
itemValidation:{} // for validate item in array
}, // maybe ajv syntax
storageResourceTags: ["xx","yy"], // reference to storageResources property
fromObjType:{
serviceTag: "xxx",
objectType: "xxx"
},
hashOnCreate: ["xx", "yy"], // reference to other fieldName,
statusField: true, // use for objectSchema inside flowSchema, identify which field is statusField

// comes from requiredOnCreate relationships
fromRequiredOnCreate: {
relType: {
serviceTag:"aa",
relationshipTag:"bb"
},
// or
belongToObjType: true, // if set to true use the belongTo relationship to belongTo objType

fieldName:"" // optional default= same field name eg: now default == xxx if not defined(use fieldname of object inside link when create)
}
},
// ...
},
compositeKeyDeliminator: "xx", // join partitionKey and sortKey
identifiers: [
// for dynamoDB storageType
{
type: "partitionKey",

fieldNames: ["xx","yy"], // composite partition keys in DynamoDB
deliminator: "xx", // optional, defaults to "_"
name: "zz", // name of field in database
// or
fieldName: "xx"

},
{
type: "sortKey",

fieldNames: ["xx","yy"], // composite partition keys in DynamoDB
deliminator: "xx", // optional, defaults to "_"
name: "zz", // name of field in database
// or
fieldName: "xx"

},

// for graph storageType
{
type: "identifier",
fieldNames: ["xx","yy"], // identifier field in graph or composite partition keys in DynamoDB
name: "zzz" // use when save in dynamoDB partitionKey
deliminator: "xx", // optional, defaults to "_"
// or
fieldName: "xx"
},
]
}
</syntaxhighlight>

== extendObjType ==

<syntaxhighlight lang="javascript">
{
// for objects stored in graph this will add another node label
objectType: "xx", // new label to add
extendObjType: { // core object that this object extends
serviceTag: "xxx",
objectType: "xxx"
},
addOnDataStructure: [],
storageResources:{ // these are the storageResources that carry the extended objects settings,
// (see above)
},
fieldNames: {
// (see above)
},
// canDelete/identifiers come from the core object
}
</syntaxhighlight>

== searchResultGenerated ==

* must be created by flow
* eg: variantProduct
* not have any storageResources
* identifiers are automatically searchResultData identifiers
* a searchResult request for this object will enter the searchResultGeneratedFlowType flow which creates searchResultData that can then be queried/sorted
* all relationships must be storageType = lambda, eg translate from variantProduct to variant uses a translateId flow to query the variantProduct identifier (searchResultData) to find the variantId in it's requiredData results
* searchResultGeneratedFlowType takes over after creating searchResultMain record until processRequiredData
* if objectSchema defines any fieldnames, then they are found using a flow, maybe as hooks in per service findData
* when finding direct fieldname, will need to check if requireData already exists, if not enter flow/findData to create
* no fields can be edited, so can show in forms but no updates performed

= Relationships Schema | ObjectRelationships.js =

* stored in top level schemas folder
* parent/child determines relationship direction for graph relationships
* have one service that contains information of each relationship

<syntaxhighlight lang="javascript">
// relationship schema in responsible service
[
{
"xxx": { // relationshipTag - name of relationship type stored in graph
generatedBy: "userGenerated" || "systemGenerated" // default="userGenerated"
canChangeToRelTypes: [
{
relType: { // relType that this relType can change to
serviceTag:"xxx",
relationshipTag: "yyy"
},
changeBy: "user" // "systemNoUserId" | "systemWithUserId" | "user", default="user"
}
// another relType
],
storageResources:{
"xxx":{ // storageResourceTag
storageType: "xx", // dynamoDB | graph | lambda
// if storageType="dynamoDB" will not specify tableName in relationship schema

// setting for storageType graph
graphServerTag: "xx",
additionalGraphIndexes:[['fieldName1', 'fieldName2', ...], [...]], // will make graph index with specific fieldName

// setting for storageType lambda
serviceTag: "xx",
functionName: "xx",
}
},
fieldNames: {
"xxx": { // relationship property name
type: "string", // "string" | "number" ...
requiredOnCreate: false, // default=false
optionalOnCreate: false, // default = false
updateBy: "user" // "systemNoUserId" | "systemWithUserId" | "user" | "none", default="user"
validation: {} // ajv syntax
},
//...other relationship properties
},
links: [
{
storageResourceTags: ["xxx"], // reference from storageResources property
canDelete: false // default = false, if set true will allow delete relationship between 2 objType
from: {
objType: {
serviceTag: "xx",
objectType: "xx"
},
requiredOnCreate: true, // if set true will create relationshipTag when create objType data, if both "from" and "to" linkType="many" should not have requiredOnCreate, exists in "from" or "to" only
linkType: "", // one | many
},
to: {
objType: {
serviceTag: "yy",
objectType: "yy"
},
linkType: "", // one | many
// moveBy allows the relationship to be moved between 2 instances of the same objType only
moveBy: "none" // "systemNoUserId" | "systemWithUserId" | "user" | "none", default="none"
},
requestProperties: {
// if storageType is Lambda and translateIds/linkPath requires properties set them here (eg sellOffer>orderPrice)
tag_deliverTo: {
requestPropertyType: "objectIdentifier",
objType: {
serviceTag: "Locations",
objectType: "locationNode" // deliversToLocationNode
},
identifiersFieldName: "locationNodeId"
},
// ... other request properties
}
}
// ...other link
]
}
}
]

</syntaxhighlight>

= Reference Relationships Schema | RefObjectRelationships.js =

<syntaxhighlight lang="javascript">
// reference to relationshipTag in external service
[
{
objectType: "zz", // objectType in local service
relationshipTag: "xxx", // name of relationshiptag of objType
relationshipServiceTag: "xx" // point to service tag that contain data of relationshipTag of objType
}
]

</syntaxhighlight>

= Flow Schema | FlowSchemas.js =

<syntaxhighlight lang="javascript">
[
{
flowTag: "yyy",
initiateBy:"user", // "user" | "system" -- if receive plugin should be user
handleObj:"one", // "one" | "multi"
statusType:"statusField", // "statusField" | "storedCache" | "none" | "triggerCache"

// statusType="triggerCache" setting
triggerType: "storedCache", // "storedCache" | "switch"
triggerFlowTypes:[
//... triggerFlowType
],

// statusType="statusField" | "triggerCache" | "storedCache" setting:
objType:{},

event:["ownTopic"], // "ownTopic" | "extTopic" | "s3" | "eventBridge" | "lambdaSyncInv" | "lambdaSyncApi" | "generatedCode"

// event="s3" setting
bucketName: "xxx", // bucket for s3 event
createBucket: boolean, // if true will generate new bucket with bucketName if false will point to old bucket that already have

// event="eventBridge" setting
schedules:[
{
name: 'your-scheduled-rate-event-name',
description: 'your scheduled rate event description',
rate: ["rate(1 minute)", ],
input:{}
}
],

// event="generatedCode" setting
generatedCodeConfig:{
generatedCodeTag: "create", // tag for generated code, eg "create" | "update" | "delete"
codeHookTag: "xx", // which codeHook to initiate flow from
// maybe validate: invocationType must exist in "event" array, so don't need to check 2 places when eg creating sns topic
invocationType: "ownTopic", // "ownTopic" | "lambdaSyncInv"

objType: {}, // which cases in the generated code trigger the flow
// .. other settings depending on generated code
}

outputTopic: boolean,

flowSteps:[
inTag:{ // will generate Topic serviceTag_stage_yyy_inTag
properties:[], // reference to stepProperties key, the first lambda's input properties and messageAttributes are the flow's input properties and messageAttributes
messageAttributes: [], // reference to stepProperties key
plugInHooks: [
{
plugInHookTag: "",
objType:{}, // used to query connection dynamo for an object instance in current flow
},
],
returnValues: [
properties:[], // reference to stepProperties key
messageAttributes: [], // reference to stepProperties key, only for outputTopic=true
],

},
// another flow steps
flowStep1:{ // will generate Topic serviceTag_stage_yyy_Flow1
properties:[], // reference to stepProperties key
messageAttributes: [] // reference to stepProperties key
event:["ownTopic"], // "ownTopic" | "extTopic" | "s3" | "eventBridge" | "lambdaSyncInv" | "lambdaSyncApi" | "generatedCode"
// handle splitting logic into awaitingStep/awaitingMultipleSteps
// handle splitting logic into paginated lambda

plugInHooks: [
{
plugInHookTag: "",
objType:{}, // used to query connection dynamo for an object instance in current flow
},
],
returnValues: [ // the last lambda function returnValues are the flow's returnValues
properties:[], // reference to stepProperties key
messageAttributes: [], // reference to stepProperties key, only for outputTopic=true
],

},
]

stepProperties:{ // normalized all stepProperties
"uuid":{
propertyName:"xxx",
type:"string",
},
"uuid2":{
objectField:{
objType:{},
fieldName:"xx"
},
overwritePropertyName:"xx" // optional, if have objectField and have overwritePropertyName will overwrite fieldName
}
},
stepMessageAttributes:{ // normalized all stepMessageAttributes
"uuid":{
propertyName:"xxx",
type:"string",
},
"uuid2":{
propertyName:"yyy",
type:"string",
}
},
}
]
</syntaxhighlight>

= System Text Schema | SystemTextSchemas.js =

<syntaxhighlight lang="javascript">
[
{
namespace: "xxx", // groups files downloaded by frontend
systemTextTag: "yyy",
}
]
</syntaxhighlight>

== Auto generated systemText and namespaces ==

=== systemNotification names ===

* namespace: "sysNotification_{notificationGrouping}"
* systemTextTag: "{notificationTag}"
* eg shown on notification settings page

=== objType names ===

* namespace: "objTypes"
* systemTextTag: "{serviceTag}_{objectType}"
* eg shown on config pages, eg pulldown list of object types

=== objType field name descriptions ===

* namespace: "objType_fielddesc_{serviceTag}_{objectType}"
* systemTextTag: "{fieldname}"
* eg shown on config pages, eg info box for each field name

= System Notification Schema | SystemNotificationSchemas.js =

<syntaxhighlight lang="javascript">
[
{
notificationTag: "xxx",
notificationGrouping: "yyy",
weight: "##",
},
]
</syntaxhighlight>

= Generated S3 files =

* generate multiple files for different uses, eg:
*# list of saved fieldNames for Create
*# list of saved+calculated for Update/Info pages
*# graphSchemas
*# relationships (used by Search/Sort Results)

= Use Cases =

== Find Deployed Service Name ==

* other services can use fixed serviceTag to get deployed serviceName from serviceSchema on S3
* used to build resource names for external services
* eg when one service needs to send a message into an SNS belonging to a different service

== Standard Create, Update, List, Delete pages ==

* List and Delete are maybe not required, use table data system instead.
* object schema can add validation information that can be used on the frontend to check before sending to backend, and by the backend to validate the data before handling

=== Create Object ===

* can configure what fields are shown
* requiredOnCreate fields must be shown

=== Edit Object ===

* users setup any number of pages for object types with configurable fields shown
* fields can be either display only or edit
* each field can adjust it's display properties (perhaps via cssStyles)

== Menu Config ==

When adding menu items can add links to create, update, list, delete objects, user chooses the service then from that service's list of objects and what action is being performed. For update/delete perhaps links to a standard page that asks for the identifier before presenting the page.

== Tabled Data ==

When viewing tabled data the frontend pulls the tableId's config from backend, then when requesting the data also requests the serviceTag > objectType schema for use when displaying the data.

== Code Standardization ==

Code such as middleware validation schema and saving data to databases can be standardized.

== Code Generation ==

Endpoints per object for actions such as Create/Delete/Update can be automatically generated from objectSchema.

=== Code Generation Structure ===

* npm for generic code generation, can be used in any project, includes functions for generating Source files from templates and developer files
* npm for per project specific files, eg templates for the project (Create/Update/.. code)
* Empty Service Template has GenerateCode.js script file in root dir that is run to generate code, it invokes a generation function from generic npm with param that points to per project npm's templates
* generated Source retains hook tags (and any developer added code), so if developer wants to update developer's file with updated template code they can generate code and simply copy generated Source to src folder

= Graph Server Config =

* S3 has a list of graphServerTag's linking to the GraphHandler serviceTag responsible for the graph
* multiple graphServerTags can point to one GraphHandler, combining graphs into one server
* when creating each GraphHandler's graph schemas, for each field split out the fields into each GraphHandler using the graphServerTag, if multiple graphServerTags for a field point to the same GraphHandler combine the fields to create GraphHandler's graph schema
* every GraphHandler an object is saved into will require it's identifiers
* when eg updating fields for an object separate the fields per GraphHandler before sending the request to update each graph

= Extended Object Types =

* Allows for one graph node to have multiple labels
* graph schema is created for both the core object and the extended object
* eg Media Manager's has a node schema for "media" object type, and Image service has a node schema for "image" object type
* the extended object builds it's schema by combining core + extended settings

= Working documents =

[[:Category:Working_documents - Per Service Schemas|Per Service Schemas]]

2025-03-06 - Graph Handler Docs

2026-06-11T08:11:59Z

Seagame: /* Request Example */

= GraphHandler Function =
== CreateNode ==
'''Use Case of CreateNode''' >>> https://izara.io/wiki/index.php/2025-03-27_Graph_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
* setFieldConditionals
** type : array
** Required : optional
* deepPathConditional
** type : array
** Required : optional
* parentFlowId
** type : string
** Required: true
* callingFlowConfig
** Type: object
** Required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType": {
"objectType": string,
"serviceTag": string
},
"objInstanceFull": {
"identifiers": {
// ...identifier
},
"fields": {
// ...fields
}
},
setFieldConditionals: [ // optional default array
{
objType: { },
indexValue: { nameSpace: 'ex-011', systemTextTag: 'Gate-011' }, // index field : value
fieldName: '', // fieldName want to set
passValue: 'false', optional
notPassValue: 'true', //optional
conditionals: [ optional ] // condition check field
}
],
"relationships": [
{
"relType": {
"serviceTag": string,
"relationshipTag": string
},
"relationshipProperties": {
//... key and value of targetIdentifiers
},
"relationshipDirection": string, // "from" | "to"
"targetObjType": {
"serviceTag": string,
"objectType": string
},
"targetIdentifiers": {
//... targetIdentifiers
}
}
],
deepPathConditional: [ // optional default array
{
condition: 'notExist', //
conditionCheck: { // traversal
nodeStructure: {
objType: { },
fields: { }
},
nextPath: {
relationshipStructure: {
relType: { },
relationshipDirection: 'to'
},
nodeStructure: {
objType: { },
fields: { }
}
}
}
}
],
"originTimestamp": number, // timestamp when create
"settings": {
"updatePropertiesOnMatch": boolean // default=false
},
"parentFlowId": "", // required
"callingFlow": string,
"callingFlowProperties": object,
}
</syntaxhighlight>

=== 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.relationships
** Type: array
** Description: data from relationships in targetNode
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* Status
** Type: string
** Description: Status from create node. Return "error" or "complete".
* errorsFound
** Type: array
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">

{
returnValue: {
queryResult: {
returnCreateNode: {
objTypes: [
{
serviceTag: "string",
objectType: "string"
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//...fields
}
},
existsNode: { },
userNode: { // // if has userNode send to createNode
objTypes: [
{
"serviceTag": "UserAccount",
"objectType": "user"
}
],
properties: {
//...properties
}
},
relationships: [ // optional : if has requiredOnCreated , createNode with targetNode
{
objTypes: [
{ serviceTag: 'string', objectType: 'string' }
],
objInstanceFull: {
identifiers: {
// identifiers
}
},
relType: {
serviceTag: 'string',
relationshipTag: 'rel'
},
relationshipProperties: {
// properties
}
},
]
}
},
requestParams: {
// return example send param
},
parentFlowId:""
},
status: "string", // "complete' or "error"
errorsFound: [],
graphServiceTag: "GraphHandler"
}

</syntaxhighlight>

== GetNode ==
'''Use Case of GetNode''' >>> https://izara.io/wiki/index.php/2025-04-23_Graph_Use_Case/GetNode_and_GetNodes#Use_Case_GetNodes
=== 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
* versionedDataLabels
** Type: Array
** Required : optional
* settings.updatePropertiesOnMatch
** Type: Boolean
** Required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":string,
"objectType":string
},
"objInstanceFull":{
"identifiers":{
// ...identifier
},
"fields":{
// ...fields
}
},
"versionedDataLabels":[
//…versionedData
],
"settings": {
"returnSystemFieldsName" :boolean // default = true or false
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* returnValue.queryResult
** Type: object
* queryResult.refactoredNodes
** Type: object
** Description: return object from getNode
* refactoredNodes.objTypes
** Type: array
* refactoredNodes.objInstanceFull
** Type: object
* refactoredNodes.objInstanceFull.identifiers
** Type: object
* refactoredNodes.objInstanceFull.fields
** Type: object
* refactoredNodes.versionDataSystemFields
** Type: object
* refactoredNodes.versionDataSystemFields.versionedDataLabel
** Type: object
* queryResult.requestParam
** Type: object
** Description: return example send param
* errorsFound
** Type: string
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
refactoredNodes: {
objTypes: [
{
serviceTag: "string",
objectType: "string",
}
],
objInstanceFull: {
identifiers: {
//… identifier
},
fields: {
//…fields
}
},
versionDataSystemFields: {
versionedDataLabel: {
originTimestamp: number,
forMatchedId: "string",
versionedDataId: "string"
}
}
}
},
requestParam: {
// return example send param
}
},
errorsFound: [],
graphServiceTag: ''
}
</syntaxhighlight>

== GetNodes ==
'''Use Case of GetNodes''' >>> https://izara.io/wiki/index.php/2025-04-23_Graph_Use_Case/GetNode_and_GetNodes#Use_Case_GetNodes
=== Request Parameters ===
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* fields
** Type : object
** Required: true
* versionedDataLabels
** Type: Array
** Required : optional
* settings.returnSystemFieldsName
** Type: Boolean
** Required : optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":string,
"objectType":string
},
"fields":{
//…fields with matching value
},
"versionedDataLabels":[
//…versionedDataLabels
],
"settings":{
"returnSystemFieldsName":boolean // default=false
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResults
** Type: object
* queryResults.getNodesReturnValues
** Type: array
* getNodesReturnValues.objTypes
** Type: array
* getNodesReturnValues.objInstanceFull
** Type: object
* getNodesReturnValues.objInstanceFull.identifiers
** Type: object
* getNodesReturnValues.objInstanceFull.fields
** Type: object
* getNodesReturnValues.versionDataSystemFields
** Type: object
* getNodesReturnValues.versionDataSystemFields.versionedDataLabel
** Type: object
* requestParams
** Type: object
* errorsFound
** Type: string
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: {
getNodesReturnValues: [
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//.. all fields-1
}
},
versionDataSystemFields: {}
},
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//...all fields-2
}
},
versionDataSystemFields: {
versionedDataLabel: {
originTimestamp: number,
forMatchedId: 'string',
versionedDataId: 'string'
}
}
}
]
},
requestParams: {
// return example send param
}
}
}
</syntaxhighlight>

== UpdateNode ==
''' Use Case of UpdateNode''' >>> https://izara.io/wiki/index.php/2025-08-03_-_Graph_Use_Case/UpdateNode
=== 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: object
** Required : true
* objInstanceFull.fields
** Type : object
** Required: true
** Description : can not send fields to update mainNode and versionedData together
* versionedDataIds
** Type: object
** Required: optional
* originTimestamp
** Type: number
** Required: true
* settings
** Type: object
** Required: optional
* parentFlowId
** type : string
** Required: true
* callingFlow
** Type: string
** Required: optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType": {
"serviceTag": string,
"objectType": string
},
"objInstanceFull": {
"identifiers": {
//…identifiers
},
"fields": {
//…fields
// can not be send fields of mainNode and versionedData in fields together!
}
},
"versionedDataIds": {},
"originTimestamp": number, //// timestamp when update
"settings": {},
"parentFlowId": ""// required
"callingFlow": string
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* returnValue.queryResult
** Type: object
** Description: data from created node
* queryResult.objTypes
** Type: array
** Description: serviceTag and objectType
* queryResult.objInstanceFull
** Type: object
** Description: identifiers and fields
* queryResult.userId
** Type: object
** Description: data that update from user Account
* queryResult.versionDataSystemFields
** Type: object
** Description: optional return versionedData
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* returnValue.Status
** Type: string
** Description: status from updated node // error or complete
* returnValue.errorsFound
** Type: array
* returnValue.graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifiers
},
fields: {
//...fields
}
},
userId: {
// if have userNode send to updated
},
versionDataSystemFields: {
versionedDataLabel: {
}
}
},
requestParams: {
// return example send param
},
parentFlowId:""
},
status: 'string',//"complete" // "error"
errorsFound: [],
graphServiceTag: 'string'
}
</syntaxhighlight>

== CreateRelationship ==
''' Use Case of CreateRelationship''' >>> https://izara.io/wiki/index.php/2025-08-01_-_Graph_Use_Case/CreateRelationship
=== Request Parameters ===
* firstObject
** Type: object
** Required: true
* secondObject
** Type: object
** Required: true
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* identifiers
** Type: object
** Required : true
* additionalRelationships
** Type: array of object
** Required: optional
* relType
** Type: object
** Required: true
* relationshipDirection
** Type: string
** Required: true
* relationshipProperties
** Type: object
** Required: true
* deepPathConditional
** Type : array
** Required: optional
** Description : using deepPathConditional for check relationship if not exist , can check on firstNode and seconNode or additionalRelationships
* Settings
** Type: object
** Required: true
* settings.updateRelPropsWhenExist
** Type: boolean
** Required: optional
* parentFlowId
** type : string
** Required: true
* callingFlow
** Type: string
** Required: optional
* callingFlowConfig
** Type: object
** Required: optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject": {
"objType": {
"serviceTag": string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"additionalRelationships": [
{
"objType": {
"serviceTag":string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"relType": {
"serviceTag":string,
"relationshipTag":string
},
"relationshipProperties": {
//…properties
},
"relationshipDirection":string ,// “from” , “to”
"deepPathConditional": []
}
]
},
"secondObject": {
"objType": {
"serviceTag":string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"additionalRelationships": [
//…optional
]
},
"relType": {
"serviceTag":string,
"relationshipTag":string
},
"relationshipDirection":string, // “from” , “to”
"relationshipProperties": {
//…properties
},
"deepPathConditional": [ // default []
{
condition: 'notExist',
conditionCheck: {
nodeStructure: {
objType: {

},
fields: { }
},
nextPath: {
relationshipStructure: {
relType: {

},
relationshipDirection: ''
},
nodeStructure: {
objType: {

},
fields: { }
}
}
}
}
]
"settings": {
"createOnConditionalFail": false // true default = false
"updateRelPropsWhenExist": false, || true// default = false
},
"parentFlowId": "", // required
"callingFlow": "xxxx",
"callingFlowProperties": {
"graphServiceName": string
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.relationship
** Type: object
* queryResult.relationship.relType
** Type: object
* queryResult.relationship.relationshipProperties
** Type: object
* queryResult.firstNode
** Type: object
** Description: return data structure from firstNode
* queryResult.secondNode
** Type: object
** Description: return data structure from secondNode
* queryResult..onCreateAddRelationships
** Type: array
** Description: return data structure from onCreateAddRelationships
* returnValue.firstObject
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* Status
** Type: string
** Description: status from create node // error or complete
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
relationship: {
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//…properties
}
},
firstNode: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: { //… identifiers },
fields: {
//… all fields
}
},
onCreateAddRelationships: [
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//… identifiers
},
fields: {
//… all fields
}
},
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//… all properties
}
}
]
},
secondNode: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: { //… identifiers },
fields: {
//… all fields
}
},
onCreateAddRelationships: [
//… optional
]
}
}
}
}
requestParams: {
// return example send param

},
parentFlowId: "",
Status: 'string', //“complete” // “error”
errorsFound: []
}
}
</syntaxhighlight>

== GetRelationship ==
=== Request Parameters ===
* firstObject
** Type: object
** Required: optional
* secondObject
** Type: object
** Required: optional
* objType
** Type: object
** Required: true
** Description: has serviceTag and objectType
* identifiers
** Type: object
** Required: true
* relType
** Type: object
** Required: true
** Description: has relationshipTag and serviceTag
* relId
** Type: string
** Required: true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag":string,
"objectType":string
},
"identifiers":{
//…identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"relType":{ // required
"relationshipTag": string,
"serviceTag": string
},
"relId": 'string' // // required
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
* Type: object
* queryResult.relType
** Type: object
* queryResult.relationshipProperties
** Type: object
** Description: return relId and properties
* returnValue.toObject
** Type: object
** Description: return toObject if not send secondObject from param
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* errorsFound
** Type: array
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: {
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//…properties : 'string’
}
},
toObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: {
identifiers: {
//
},
fields: { }
}
},
requestParams: {
// return example send param
}
}
}

</syntaxhighlight>

== UpdateRelationship ==
=== Request Parameters ===
* firstObject
** Type: object
** Required: optional
* secondObject
** Type: object
** Required: Optional
* objType
** Type: object
** Required: true
** Description: has serviceTag and objectType
* identifiers
** Type: object
** Required: true
* relId
** Type: string
** Required: true
* relType
** Type: object
** Required: true
** Description: has relationshipTag and serviceTag
* relationshipProperties
** Type: object
** Required: true
** Description: send properties that want to update
* relationshipDirection
** Type: string
** Required: optional
* parentFlowId
** Type : string
** Required : true
* callingFlow
** Type: string
** Required: optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"relId": string,
"relType":{
"serviceTag":string,
"relationshipTag":string
},
"relationshipProperties":{
//… properties that want to update
},
"relationshipDirection": string, // "from" // “to”
"parentFlowId": ""// required
"callingFlow": string
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.firstObject And secondObject
** Type: object
** Description : return objType {seviceTag and objectType} And identifiers
* queryResult.relId
** Type: string
* queryResult.relType
** Type: object
** Description: return {seviceTag and relationshipTag}
* queryResult.relationshipDirection
** Type: string
* queryResult.updatePropertiesParam
** Type: object
** Description: return properties to updated
* queryResult.oldRelationshipProperties
** Type: object
** Description: return old properties before update
* queryResult.newRelationshipProperties
** Type: object
** Description: return new properties after updated
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type : string
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
firstObject: {
objType: {
serviceTag: "string",
objectType: "string"
},
identifiers: {
//…identifiers
}
},
secondObject: {
objType: {
serviceTag: "string",
objectType: "string"
},
identifiers: {
//…identifiers
}
},
relId: "string",
relType: {
serviceTag: "string",
relationshipTag: "string"
},
relationshipDirection: "string",
updatePropertiesParam: {
//… properties updated
},
oldRelationshipProperties: {
// … old properties before update
},
newRelationshipProperties: {
//… new properties after updated
}
}
},
requestParams: {
// return example send param
},
parentFlowId:"",
status: “string”, // "complete",”error”
errorsFound: []
}
</syntaxhighlight>

== GetNodeAndRelationship ==
=== Request Parameters ===
* sourceObjType
** Required: true
** Description: has serviceTag and objectType
* sourceIdentifiers
** Type: object
** Required: true
* sourceVersionedDataLabels
** Type: object
** Required: optional
* targetRelationships
** Type: Array
** Required: true
* relTypeAndDirection
** Type: object
** Required: true
* relTypeAndDirection.relType
** Type: object
** Required: true
** Description: has serviceTag and relationshipTag
* relTypeAndDirection.relationshipProperties
** Type: object
** Required: optional
* relTypeAndDirection.relationshipDirection
** Type: String
** Required: optional
* targetObjects
** Type: Array
** Required: Optional
* targetObjects.objType
** Type: object
** Required: required if send targetObjects in param
* targetObjects.identifiers
** Type: object
** Required: optional should have objType if identifiers exists
* targetObjects.versionedDataLabels
** Type: object
** Required: optional have objType if versionedDataLabels exists

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"sourceObjType": { // required
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"sourceIdentifiers": {}, // required
"sourceVersionedDataLabels": [], // optional
"targetRelationships": [ //required
{
"relTypeAndDirection": { // required
"relType": {
"serviceTag": "xxxx",
"relationshipTag": "rel"
},
"relationshipProperties": {},//optional
"relationshipDirection": "" // required
},
"targetObjects": [ // optional
{
"objType": {
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"identifiers": {}, // optional
"versionedDataLabels": [] // optional have objType if versionedDataLabels exists
}
]
},
// if have multiple relTypeAndDirection
],
"settings": {} // defaulf = false >>> if have versionedDataLabels want to return all field of versionedata: settings = { returnSystemFieldsName: true }
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.objTypes
** Type: array of object
** Description: return {serviceTag and objectType}
* queryResult.objInstanceFull
** Type: object
** Description: return {identifiers and fields}
* queryResult.relNodes:
** Type: array
* relNodes.relType
** Type: object
** Description: return {serviceTag and relationshipTag}
* relNodes.relationshipProperties
** Type: object
* relNodes.objTypes
** Type: array of object
** Description: return {serviceTag and objectType}
* relNodes.objInstanceFull
** Type: object
** Description: return {identifiers and fields}
* requestParams
** Type: object
** Description: return same requestParams
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: {},
fields: { }
},
relNodes: [
{
relType: {
serviceTag: 'xxxx',
relationshipTag: 'rel'
},
relationshipProperties: { },
objTypes: [
{
serviceTag: 'xxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: {},
fields: {
// field
}
},
versionDataSystemFields: {
'0VersionDataLabel': {
originTimestamp:
forMatchedId:
versionedDataId:
}
}
}
]
}
},
requestParam : {
// return example send param
},
errorsFound: [],
graphServiceTag: "GraphHandler"
}

</syntaxhighlight>

== ChangeRelationshipType ==
=== Request Parameters ===
* firstObject
** Type : object
** Required : true
* secondObject
** Type : object
** Required : true
* objType
** Type : object
** Required : true
* Identifiers
** Type : object
** Required : true
* oldRelTypeAndDirection
** Type : object
** Required : true
* oldRelTypeAndDirection.relType
** Type : object
** Required : true
* oldRelTypeAndDirection.relationshipDirection
** Type : string
** Required : true
* oldRelTypeAndDirection.relationshipProperties
** Type : object
** Required : optional
* newRelType
** Type : object
** Required : true
* originTimestamp
** Type : number
** Required : true
* changedByUserId
** Type : String
** Required : true
* settings
** Type : object
** Required : optional
** Description : default > settings.changeMultipleRelationships : false // if send settings.changeMultipleRelationships : true >> can change multiple relType
* parentFlowId
** Type: string
** required: true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"secondObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"oldRelTypeAndDirection":{
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"old"
},
"relationshipDirection":"from",
"relationshipProperties":{
//Properties
}
},
"newRelType":{
"serviceTag":"xxxx",
"relationshipTag":"new"
},
"originTimestamp":1234567890,
"changedByUserId":"xxxx",
"settings":{
"changeMultipleRelationships": boolean: // default false
},
parentFlowId: "" // required
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.newRelationshipType
** Type: object
* newRelationshipType.relType
** Type: object
* newRelationshipType.relationshipDirection
** Type: string
* newRelationshipType.relationshipProperties
** Type: object
* queryResult.oldRelationshipType
** Type: object
* oldRelationshipType.relType
** Type: object
* oldRelationshipType.relationshipDirection
** Type: string
* oldRelationshipType.relationshipProperties
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
newRelationshipType: {
relType: {
serviceTag: "xxxx",
relationshipTag: "new"
},
relationshipDirection: "" // 'from' or 'to'
relationshipProperties: {}
},
oldRelationshipType: {
relType: {
serviceTag: "xxxx",
relationshipTag: "old"
},
relationshipDirection: "" // 'from' or 'to'
relationshipProperties: {}
}
},
requestParams : {
// return example send param
}
},
status: "complete" // or error,
errorsFound: [],
graphServiceTag : 'GraphHandeler'
}

</syntaxhighlight>

== DeleteRelationship ==
=== Request Parameters ===
* fromObject
** Type : object
** Required : optional
* secondObject
** Type : object
** Required : optional
* objType
** Type : object
** Required : true
* Identifiers
** Type : object
** Required : true
* relType
** Type : object
** Required : true
* relId
** Type: string
** Required : true
* relationshipDirection
** Type: string
** Required : optional
* parentFlowId
** Type: string
** Requird: true
* callingFlow
** Type: string
** Required : true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"yyyy"
},
"relId":"string"
},
"relationshipDirection":"string"// "from" or "to"
"parentFlowIf": "", // required
"callingFlow":"string"
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.objects
** Type: array
* queryResult.objTypes
** Type: array
* queryResult.objInstanceFull.identifiers
** Type: object
* queryResult.objInstanceFull.fields
** Type: object
** Description: return data of fromObject and secondObject
* queryResult.userNode
** Type: object
** Description: return data of userNode
* queryResult.resultDeleteRel
** Type : string
** Description: return status Relationship Delete
* requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objects: [
{
objTypes: [
{
serviceTag: "xxxx",
objectType: "yyyy"
}
],
objInstanceFull: {
identifiers: {
// identifiers
},
fields: {
// fields
}
}
},
{
// if have multiple object objTypes
}
],
userNode: {
objTypes: [
{
serviceTag: "UserAccount",
objectType: "user"
}
],
objInstanceFull: {
identifiers: {
userId: "zzz"
}
}
},
resultDeleteRel: "Relationship Deleted" // default
},
requeatParam: {
// return example send param
},
status: "string", //default "complete" or "error"
errorsFound: []
}
}

</syntaxhighlight>

== DeleteNode ==
=== Request Parameters ===
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* identifiers
** Type : object
** Required: true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":"xxx",
"objectType":"yyy"
},
"identifiers":{
//
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResults
** Type: object
* queryResults.resultDeleteNode
** Type: Boolean
** Description: return status deleted node >> true or false
* requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
** Description: return status deleted node >> complete or error
* errorsFound
** Type: array
* graphServiceTag
** Type: string
=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: { resultDeleteNode: true }, // true or false
requestParams: {
// return example send param
}
},
status: 'string', // 'complete' or 'error'
errorsFound: [],
graphServiceTag: 'GraphHandler'
}
</syntaxhighlight>

== MoveRelationship ==

=== Request Parameters ===
* sourceObject
** Type : object
** Required : true
** Description: required objType: {serviceTag , objectType} and identifiers
* targetObjType
** Type : object
** Required : true
** Description: required objType: {serviceTag , objectType}
* relType
** Type : object
** Required : true
** Description: required objType: {serviceTag , relationshipTag}
* relationshipDirection
** Type : object
** Required : true
* moveToIdentifiers
** Type : object
** Required : true
* moveByUserId
** Type : String
** Required : true
* originTimestamp
** Type : number
** Required : true
* settings
** Type : object
** Required : optional // default {}
* parentFlowId
** Type: string
** Requied: true
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"sourceObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyy"
},
"identifiers":{
// identifiers
}
},
"targetObjType":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
}
},
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"rel"
},
"relationshipDirection":"from", // "to"
"moveToIdentifiers":{
// target identifiers
},
"moveByUserId":"xxxx",
"originTimestamp":1234567890,
"settings":{},
"parentFlowId": "" // required
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.moveRelationship
** Type: object
* moveRelationship.sourceObject
** Type: object
** Description: return data of sourceObject
* moveRelationship.relationship
** Type: string
** Description: return data of after move relationship
* moveRelationship.moveToObject
** Type: object
** Description: return data of moveToObject
* moveRelationship.historyData
** Type: object
** Description: return properties {old target identifiers and originTimestamp} after moveRelationship
* moveRelationship.userNode
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
moveRelationship: {
sourceObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
}
},
relationship: {
relType: {
serviceTag: 'xxxx',
relationshipTag: 'rel'
},
relationshipProperties: { originTimestamp: 1234567890 }
},
moveToObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: { }
},
historyData: {
relationshipProperties: { }
},
userNode: {
objTypes: [{ serviceTag: 'UserAccount', objectType: 'user' }],
objInstanceFull: { }
}
}
},
requestParam: {
},
parentFlowId:""
}
status: "complete" // or error,
errorsFound: [],
graphServiceTag: 'GraphHandler'
}

</syntaxhighlight>

== MoveNodeProperties ==
=== Request Parameters ===
* sourceObject
** type: object
** required : true
* targetIdentifiers
** type : object
** required : true
* moveProperties
** type : array
** required : true // index minimum = 1
* updateProperties
** type : object
** required : true
* movePropertiesConditions
** type : array
** required : optional
* parentFlowId
** Type: string
** required : true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
sourceObject: {
objType: { },
identifier: { }
},
targetIdentifiers: { },
moveProperties: [ ],
updateProperties: { },
movePropertiesConditions: [ // optional
{
checkObject: 'target', // "source" | "target"
onSetObject: 'target', // "source" | "target"
onPassValue: true,
onNotPassCondition: false, // optional
fieldNameConditions: [ ]
}
],
parentFlowId:""// required
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.moveNodeProperties
** Type: object
* moveNodeProperties.sourceObject
** Type: object
** Description: return data of sourceObject
* moveRelationship.moveFieldToObject
** Type: string
** Description: return data after moveFieldToObject
* moveRelationship.movedFields
** Type: object
** Description: return data field of moveToObject
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String
=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
moveNodeProperties: {
sourceObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: {
identifiers: { },
fields: { }
}
},
moveFieldToObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: { },
fields: {

}
},
movedFields: { Fields: { } } //
}
}
},
requestParam: { },
parentFlowId: "",
status: 'complete',
errorsFound: [],
graphServiceTag: 'GraphHandler'
}
</syntaxhighlight>
[[Category:Working documents| 2025-03-06]]

2025-03-06 - Graph Handler Docs

2026-06-11T07:42:44Z

Seagame: /* MoveNodeProperties */

= GraphHandler Function =
== CreateNode ==
'''Use Case of CreateNode''' >>> https://izara.io/wiki/index.php/2025-03-27_Graph_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
* setFieldConditionals
** type : array
** Required : optional
* deepPathConditional
** type : array
** Required : optional
* parentFlowId
** type : string
** Required: true
* callingFlowConfig
** Type: object
** Required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType": {
"objectType": string,
"serviceTag": string
},
"objInstanceFull": {
"identifiers": {
// ...identifier
},
"fields": {
// ...fields
}
},
setFieldConditionals: [ // optional default array
{
objType: { },
indexValue: { nameSpace: 'ex-011', systemTextTag: 'Gate-011' }, // index field : value
fieldName: '', // fieldName want to set
passValue: 'false', optional
notPassValue: 'true', //optional
conditionals: [ optional ] // condition check field
}
],
"relationships": [
{
"relType": {
"serviceTag": string,
"relationshipTag": string
},
"relationshipProperties": {
//... key and value of targetIdentifiers
},
"relationshipDirection": string, // "from" | "to"
"targetObjType": {
"serviceTag": string,
"objectType": string
},
"targetIdentifiers": {
//... targetIdentifiers
}
}
],
deepPathConditional: [ // optional default array
{
condition: 'notExist', //
conditionCheck: { // traversal
nodeStructure: {
objType: { },
fields: { }
},
nextPath: {
relationshipStructure: {
relType: { },
relationshipDirection: 'to'
},
nodeStructure: {
objType: { },
fields: { }
}
}
}
}
],
"originTimestamp": number, // timestamp when create
"settings": {
"updatePropertiesOnMatch": boolean // default=false
},
"parentFlowId": "", // required
"callingFlow": string,
"callingFlowProperties": object,
}
</syntaxhighlight>

=== 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.relationships
** Type: array
** Description: data from relationships in targetNode
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* Status
** Type: string
** Description: Status from create node. Return "error" or "complete".
* errorsFound
** Type: array
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">

{
returnValue: {
queryResult: {
returnCreateNode: {
objTypes: [
{
serviceTag: "string",
objectType: "string"
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//...fields
}
},
existsNode: { },
userNode: { // // if has userNode send to createNode
objTypes: [
{
"serviceTag": "UserAccount",
"objectType": "user"
}
],
properties: {
//...properties
}
},
relationships: [ // optional : if has requiredOnCreated , createNode with targetNode
{
objTypes: [
{ serviceTag: 'string', objectType: 'string' }
],
objInstanceFull: {
identifiers: {
// identifiers
}
},
relType: {
serviceTag: 'string',
relationshipTag: 'rel'
},
relationshipProperties: {
// properties
}
},
]
}
},
requestParams: {
// return example send param
},
parentFlowId:""
},
status: "string", // "complete' or "error"
errorsFound: [],
graphServiceTag: "GraphHandler"
}

</syntaxhighlight>

== GetNode ==
'''Use Case of GetNode''' >>> https://izara.io/wiki/index.php/2025-04-23_Graph_Use_Case/GetNode_and_GetNodes#Use_Case_GetNodes
=== 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
* versionedDataLabels
** Type: Array
** Required : optional
* settings.updatePropertiesOnMatch
** Type: Boolean
** Required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":string,
"objectType":string
},
"objInstanceFull":{
"identifiers":{
// ...identifier
},
"fields":{
// ...fields
}
},
"versionedDataLabels":[
//…versionedData
],
"settings": {
"returnSystemFieldsName" :boolean // default = true or false
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* returnValue.queryResult
** Type: object
* queryResult.refactoredNodes
** Type: object
** Description: return object from getNode
* refactoredNodes.objTypes
** Type: array
* refactoredNodes.objInstanceFull
** Type: object
* refactoredNodes.objInstanceFull.identifiers
** Type: object
* refactoredNodes.objInstanceFull.fields
** Type: object
* refactoredNodes.versionDataSystemFields
** Type: object
* refactoredNodes.versionDataSystemFields.versionedDataLabel
** Type: object
* queryResult.requestParam
** Type: object
** Description: return example send param
* errorsFound
** Type: string
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
refactoredNodes: {
objTypes: [
{
serviceTag: "string",
objectType: "string",
}
],
objInstanceFull: {
identifiers: {
//… identifier
},
fields: {
//…fields
}
},
versionDataSystemFields: {
versionedDataLabel: {
originTimestamp: number,
forMatchedId: "string",
versionedDataId: "string"
}
}
}
},
requestParam: {
// return example send param
}
},
errorsFound: [],
graphServiceTag: ''
}
</syntaxhighlight>

== GetNodes ==
'''Use Case of GetNodes''' >>> https://izara.io/wiki/index.php/2025-04-23_Graph_Use_Case/GetNode_and_GetNodes#Use_Case_GetNodes
=== Request Parameters ===
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* fields
** Type : object
** Required: true
* versionedDataLabels
** Type: Array
** Required : optional
* settings.returnSystemFieldsName
** Type: Boolean
** Required : optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":string,
"objectType":string
},
"fields":{
//…fields with matching value
},
"versionedDataLabels":[
//…versionedDataLabels
],
"settings":{
"returnSystemFieldsName":boolean // default=false
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResults
** Type: object
* queryResults.getNodesReturnValues
** Type: array
* getNodesReturnValues.objTypes
** Type: array
* getNodesReturnValues.objInstanceFull
** Type: object
* getNodesReturnValues.objInstanceFull.identifiers
** Type: object
* getNodesReturnValues.objInstanceFull.fields
** Type: object
* getNodesReturnValues.versionDataSystemFields
** Type: object
* getNodesReturnValues.versionDataSystemFields.versionedDataLabel
** Type: object
* requestParams
** Type: object
* errorsFound
** Type: string
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: {
getNodesReturnValues: [
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//.. all fields-1
}
},
versionDataSystemFields: {}
},
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//...all fields-2
}
},
versionDataSystemFields: {
versionedDataLabel: {
originTimestamp: number,
forMatchedId: 'string',
versionedDataId: 'string'
}
}
}
]
},
requestParams: {
// return example send param
}
}
}
</syntaxhighlight>

== UpdateNode ==
''' Use Case of UpdateNode''' >>> https://izara.io/wiki/index.php/2025-08-03_-_Graph_Use_Case/UpdateNode
=== 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: object
** Required : true
* objInstanceFull.fields
** Type : object
** Required: true
** Description : can not send fields to update mainNode and versionedData together
* versionedDataIds
** Type: object
** Required: optional
* originTimestamp
** Type: number
** Required: true
* settings
** Type: object
** Required: optional
* parentFlowId
** type : string
** Required: true
* callingFlow
** Type: string
** Required: optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType": {
"serviceTag": string,
"objectType": string
},
"objInstanceFull": {
"identifiers": {
//…identifiers
},
"fields": {
//…fields
// can not be send fields of mainNode and versionedData in fields together!
}
},
"versionedDataIds": {},
"originTimestamp": number, //// timestamp when update
"settings": {},
"parentFlowId": ""// required
"callingFlow": string
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* returnValue.queryResult
** Type: object
** Description: data from created node
* queryResult.objTypes
** Type: array
** Description: serviceTag and objectType
* queryResult.objInstanceFull
** Type: object
** Description: identifiers and fields
* queryResult.userId
** Type: object
** Description: data that update from user Account
* queryResult.versionDataSystemFields
** Type: object
** Description: optional return versionedData
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* returnValue.Status
** Type: string
** Description: status from updated node // error or complete
* returnValue.errorsFound
** Type: array
* returnValue.graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifiers
},
fields: {
//...fields
}
},
userId: {
// if have userNode send to updated
},
versionDataSystemFields: {
versionedDataLabel: {
}
}
},
requestParams: {
// return example send param
},
parentFlowId:""
},
status: 'string',//"complete" // "error"
errorsFound: [],
graphServiceTag: 'string'
}
</syntaxhighlight>

== CreateRelationship ==
''' Use Case of CreateRelationship''' >>> https://izara.io/wiki/index.php/2025-08-01_-_Graph_Use_Case/CreateRelationship
=== Request Parameters ===
* firstObject
** Type: object
** Required: true
* secondObject
** Type: object
** Required: true
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* identifiers
** Type: object
** Required : true
* additionalRelationships
** Type: array of object
** Required: optional
* relType
** Type: object
** Required: true
* relationshipDirection
** Type: string
** Required: true
* relationshipProperties
** Type: object
** Required: true
* deepPathConditional
** Type : array
** Required: optional
** Description : using deepPathConditional for check relationship if not exist , can check on firstNode and seconNode or additionalRelationships
* Settings
** Type: object
** Required: true
* settings.updateRelPropsWhenExist
** Type: boolean
** Required: optional
* parentFlowId
** type : string
** Required: true
* callingFlow
** Type: string
** Required: optional
* callingFlowConfig
** Type: object
** Required: optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject": {
"objType": {
"serviceTag": string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"additionalRelationships": [
{
"objType": {
"serviceTag":string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"relType": {
"serviceTag":string,
"relationshipTag":string
},
"relationshipProperties": {
//…properties
},
"relationshipDirection":string ,// “from” , “to”
"deepPathConditional": []
}
]
},
"secondObject": {
"objType": {
"serviceTag":string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"additionalRelationships": [
//…optional
]
},
"relType": {
"serviceTag":string,
"relationshipTag":string
},
"relationshipDirection":string, // “from” , “to”
"relationshipProperties": {
//…properties
},
"deepPathConditional": [ // default []
{
condition: 'notExist',
conditionCheck: {
nodeStructure: {
objType: {

},
fields: { }
},
nextPath: {
relationshipStructure: {
relType: {

},
relationshipDirection: ''
},
nodeStructure: {
objType: {

},
fields: { }
}
}
}
}
]
"settings": {
"reateOnConditionalFail": false // true default = false
"updateRelPropsWhenExist": boolean,
},
"parentFlowId": "", // required
"callingFlow": "xxxx",
"callingFlowProperties": {
"graphServiceName": string
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.relationship
** Type: object
* queryResult.relationship.relType
** Type: object
* queryResult.relationship.relationshipProperties
** Type: object
* queryResult.firstNode
** Type: object
** Description: return data structure from firstNode
* queryResult.secondNode
** Type: object
** Description: return data structure from secondNode
* queryResult..onCreateAddRelationships
** Type: array
** Description: return data structure from onCreateAddRelationships
* returnValue.firstObject
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* Status
** Type: string
** Description: status from create node // error or complete
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
relationship: {
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//…properties
}
},
firstNode: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: { //… identifiers },
fields: {
//… all fields
}
},
onCreateAddRelationships: [
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//… identifiers
},
fields: {
//… all fields
}
},
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//… all properties
}
}
]
},
secondNode: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: { //… identifiers },
fields: {
//… all fields
}
},
onCreateAddRelationships: [
//… optional
]
}
}
}
}
requestParams: {
// return example send param

},
parentFlowId: "",
Status: 'string', //“complete” // “error”
errorsFound: []
}
}
</syntaxhighlight>

== GetRelationship ==
=== Request Parameters ===
* firstObject
** Type: object
** Required: optional
* secondObject
** Type: object
** Required: optional
* objType
** Type: object
** Required: true
** Description: has serviceTag and objectType
* identifiers
** Type: object
** Required: true
* relType
** Type: object
** Required: true
** Description: has relationshipTag and serviceTag
* relId
** Type: string
** Required: true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag":string,
"objectType":string
},
"identifiers":{
//…identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"relType":{ // required
"relationshipTag": string,
"serviceTag": string
},
"relId": 'string' // // required
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
* Type: object
* queryResult.relType
** Type: object
* queryResult.relationshipProperties
** Type: object
** Description: return relId and properties
* returnValue.toObject
** Type: object
** Description: return toObject if not send secondObject from param
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* errorsFound
** Type: array
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: {
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//…properties : 'string’
}
},
toObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: {
identifiers: {
//
},
fields: { }
}
},
requestParams: {
// return example send param
}
}
}

</syntaxhighlight>

== UpdateRelationship ==
=== Request Parameters ===
* firstObject
** Type: object
** Required: optional
* secondObject
** Type: object
** Required: Optional
* objType
** Type: object
** Required: true
** Description: has serviceTag and objectType
* identifiers
** Type: object
** Required: true
* relId
** Type: string
** Required: true
* relType
** Type: object
** Required: true
** Description: has relationshipTag and serviceTag
* relationshipProperties
** Type: object
** Required: true
** Description: send properties that want to update
* relationshipDirection
** Type: string
** Required: optional
* parentFlowId
** Type : string
** Required : true
* callingFlow
** Type: string
** Required: optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"relId": string,
"relType":{
"serviceTag":string,
"relationshipTag":string
},
"relationshipProperties":{
//… properties that want to update
},
"relationshipDirection": string, // "from" // “to”
"parentFlowId": ""// required
"callingFlow": string
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.firstObject And secondObject
** Type: object
** Description : return objType {seviceTag and objectType} And identifiers
* queryResult.relId
** Type: string
* queryResult.relType
** Type: object
** Description: return {seviceTag and relationshipTag}
* queryResult.relationshipDirection
** Type: string
* queryResult.updatePropertiesParam
** Type: object
** Description: return properties to updated
* queryResult.oldRelationshipProperties
** Type: object
** Description: return old properties before update
* queryResult.newRelationshipProperties
** Type: object
** Description: return new properties after updated
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type : string
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
firstObject: {
objType: {
serviceTag: "string",
objectType: "string"
},
identifiers: {
//…identifiers
}
},
secondObject: {
objType: {
serviceTag: "string",
objectType: "string"
},
identifiers: {
//…identifiers
}
},
relId: "string",
relType: {
serviceTag: "string",
relationshipTag: "string"
},
relationshipDirection: "string",
updatePropertiesParam: {
//… properties updated
},
oldRelationshipProperties: {
// … old properties before update
},
newRelationshipProperties: {
//… new properties after updated
}
}
},
requestParams: {
// return example send param
},
parentFlowId:"",
status: “string”, // "complete",”error”
errorsFound: []
}
</syntaxhighlight>

== GetNodeAndRelationship ==
=== Request Parameters ===
* sourceObjType
** Required: true
** Description: has serviceTag and objectType
* sourceIdentifiers
** Type: object
** Required: true
* sourceVersionedDataLabels
** Type: object
** Required: optional
* targetRelationships
** Type: Array
** Required: true
* relTypeAndDirection
** Type: object
** Required: true
* relTypeAndDirection.relType
** Type: object
** Required: true
** Description: has serviceTag and relationshipTag
* relTypeAndDirection.relationshipProperties
** Type: object
** Required: optional
* relTypeAndDirection.relationshipDirection
** Type: String
** Required: optional
* targetObjects
** Type: Array
** Required: Optional
* targetObjects.objType
** Type: object
** Required: required if send targetObjects in param
* targetObjects.identifiers
** Type: object
** Required: optional should have objType if identifiers exists
* targetObjects.versionedDataLabels
** Type: object
** Required: optional have objType if versionedDataLabels exists

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"sourceObjType": { // required
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"sourceIdentifiers": {}, // required
"sourceVersionedDataLabels": [], // optional
"targetRelationships": [ //required
{
"relTypeAndDirection": { // required
"relType": {
"serviceTag": "xxxx",
"relationshipTag": "rel"
},
"relationshipProperties": {},//optional
"relationshipDirection": "" // required
},
"targetObjects": [ // optional
{
"objType": {
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"identifiers": {}, // optional
"versionedDataLabels": [] // optional have objType if versionedDataLabels exists
}
]
},
// if have multiple relTypeAndDirection
],
"settings": {} // defaulf = false >>> if have versionedDataLabels want to return all field of versionedata: settings = { returnSystemFieldsName: true }
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.objTypes
** Type: array of object
** Description: return {serviceTag and objectType}
* queryResult.objInstanceFull
** Type: object
** Description: return {identifiers and fields}
* queryResult.relNodes:
** Type: array
* relNodes.relType
** Type: object
** Description: return {serviceTag and relationshipTag}
* relNodes.relationshipProperties
** Type: object
* relNodes.objTypes
** Type: array of object
** Description: return {serviceTag and objectType}
* relNodes.objInstanceFull
** Type: object
** Description: return {identifiers and fields}
* requestParams
** Type: object
** Description: return same requestParams
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: {},
fields: { }
},
relNodes: [
{
relType: {
serviceTag: 'xxxx',
relationshipTag: 'rel'
},
relationshipProperties: { },
objTypes: [
{
serviceTag: 'xxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: {},
fields: {
// field
}
},
versionDataSystemFields: {
'0VersionDataLabel': {
originTimestamp:
forMatchedId:
versionedDataId:
}
}
}
]
}
},
requestParam : {
// return example send param
},
errorsFound: [],
graphServiceTag: "GraphHandler"
}

</syntaxhighlight>

== ChangeRelationshipType ==
=== Request Parameters ===
* firstObject
** Type : object
** Required : true
* secondObject
** Type : object
** Required : true
* objType
** Type : object
** Required : true
* Identifiers
** Type : object
** Required : true
* oldRelTypeAndDirection
** Type : object
** Required : true
* oldRelTypeAndDirection.relType
** Type : object
** Required : true
* oldRelTypeAndDirection.relationshipDirection
** Type : string
** Required : true
* oldRelTypeAndDirection.relationshipProperties
** Type : object
** Required : optional
* newRelType
** Type : object
** Required : true
* originTimestamp
** Type : number
** Required : true
* changedByUserId
** Type : String
** Required : true
* settings
** Type : object
** Required : optional
** Description : default > settings.changeMultipleRelationships : false // if send settings.changeMultipleRelationships : true >> can change multiple relType
* parentFlowId
** Type: string
** required: true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"secondObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"oldRelTypeAndDirection":{
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"old"
},
"relationshipDirection":"from",
"relationshipProperties":{
//Properties
}
},
"newRelType":{
"serviceTag":"xxxx",
"relationshipTag":"new"
},
"originTimestamp":1234567890,
"changedByUserId":"xxxx",
"settings":{
"changeMultipleRelationships": boolean: // default false
},
parentFlowId: "" // required
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.newRelationshipType
** Type: object
* newRelationshipType.relType
** Type: object
* newRelationshipType.relationshipDirection
** Type: string
* newRelationshipType.relationshipProperties
** Type: object
* queryResult.oldRelationshipType
** Type: object
* oldRelationshipType.relType
** Type: object
* oldRelationshipType.relationshipDirection
** Type: string
* oldRelationshipType.relationshipProperties
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
newRelationshipType: {
relType: {
serviceTag: "xxxx",
relationshipTag: "new"
},
relationshipDirection: "" // 'from' or 'to'
relationshipProperties: {}
},
oldRelationshipType: {
relType: {
serviceTag: "xxxx",
relationshipTag: "old"
},
relationshipDirection: "" // 'from' or 'to'
relationshipProperties: {}
}
},
requestParams : {
// return example send param
}
},
status: "complete" // or error,
errorsFound: [],
graphServiceTag : 'GraphHandeler'
}

</syntaxhighlight>

== DeleteRelationship ==
=== Request Parameters ===
* fromObject
** Type : object
** Required : optional
* secondObject
** Type : object
** Required : optional
* objType
** Type : object
** Required : true
* Identifiers
** Type : object
** Required : true
* relType
** Type : object
** Required : true
* relId
** Type: string
** Required : true
* relationshipDirection
** Type: string
** Required : optional
* parentFlowId
** Type: string
** Requird: true
* callingFlow
** Type: string
** Required : true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"yyyy"
},
"relId":"string"
},
"relationshipDirection":"string"// "from" or "to"
"parentFlowIf": "", // required
"callingFlow":"string"
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.objects
** Type: array
* queryResult.objTypes
** Type: array
* queryResult.objInstanceFull.identifiers
** Type: object
* queryResult.objInstanceFull.fields
** Type: object
** Description: return data of fromObject and secondObject
* queryResult.userNode
** Type: object
** Description: return data of userNode
* queryResult.resultDeleteRel
** Type : string
** Description: return status Relationship Delete
* requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objects: [
{
objTypes: [
{
serviceTag: "xxxx",
objectType: "yyyy"
}
],
objInstanceFull: {
identifiers: {
// identifiers
},
fields: {
// fields
}
}
},
{
// if have multiple object objTypes
}
],
userNode: {
objTypes: [
{
serviceTag: "UserAccount",
objectType: "user"
}
],
objInstanceFull: {
identifiers: {
userId: "zzz"
}
}
},
resultDeleteRel: "Relationship Deleted" // default
},
requeatParam: {
// return example send param
},
status: "string", //default "complete" or "error"
errorsFound: []
}
}

</syntaxhighlight>

== DeleteNode ==
=== Request Parameters ===
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* identifiers
** Type : object
** Required: true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":"xxx",
"objectType":"yyy"
},
"identifiers":{
//
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResults
** Type: object
* queryResults.resultDeleteNode
** Type: Boolean
** Description: return status deleted node >> true or false
* requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
** Description: return status deleted node >> complete or error
* errorsFound
** Type: array
* graphServiceTag
** Type: string
=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: { resultDeleteNode: true }, // true or false
requestParams: {
// return example send param
}
},
status: 'string', // 'complete' or 'error'
errorsFound: [],
graphServiceTag: 'GraphHandler'
}
</syntaxhighlight>

== MoveRelationship ==

=== Request Parameters ===
* sourceObject
** Type : object
** Required : true
** Description: required objType: {serviceTag , objectType} and identifiers
* targetObjType
** Type : object
** Required : true
** Description: required objType: {serviceTag , objectType}
* relType
** Type : object
** Required : true
** Description: required objType: {serviceTag , relationshipTag}
* relationshipDirection
** Type : object
** Required : true
* moveToIdentifiers
** Type : object
** Required : true
* moveByUserId
** Type : String
** Required : true
* originTimestamp
** Type : number
** Required : true
* settings
** Type : object
** Required : optional // default {}
* parentFlowId
** Type: string
** Requied: true
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"sourceObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyy"
},
"identifiers":{
// identifiers
}
},
"targetObjType":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
}
},
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"rel"
},
"relationshipDirection":"from", // "to"
"moveToIdentifiers":{
// target identifiers
},
"moveByUserId":"xxxx",
"originTimestamp":1234567890,
"settings":{},
"parentFlowId": "" // required
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.moveRelationship
** Type: object
* moveRelationship.sourceObject
** Type: object
** Description: return data of sourceObject
* moveRelationship.relationship
** Type: string
** Description: return data of after move relationship
* moveRelationship.moveToObject
** Type: object
** Description: return data of moveToObject
* moveRelationship.historyData
** Type: object
** Description: return properties {old target identifiers and originTimestamp} after moveRelationship
* moveRelationship.userNode
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
moveRelationship: {
sourceObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
}
},
relationship: {
relType: {
serviceTag: 'xxxx',
relationshipTag: 'rel'
},
relationshipProperties: { originTimestamp: 1234567890 }
},
moveToObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: { }
},
historyData: {
relationshipProperties: { }
},
userNode: {
objTypes: [{ serviceTag: 'UserAccount', objectType: 'user' }],
objInstanceFull: { }
}
}
},
requestParam: {
},
parentFlowId:""
}
status: "complete" // or error,
errorsFound: [],
graphServiceTag: 'GraphHandler'
}

</syntaxhighlight>

== MoveNodeProperties ==
=== Request Parameters ===
* sourceObject
** type: object
** required : true
* targetIdentifiers
** type : object
** required : true
* moveProperties
** type : array
** required : true // index minimum = 1
* updateProperties
** type : object
** required : true
* movePropertiesConditions
** type : array
** required : optional
* parentFlowId
** Type: string
** required : true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
sourceObject: {
objType: { },
identifier: { }
},
targetIdentifiers: { },
moveProperties: [ ],
updateProperties: { },
movePropertiesConditions: [ // optional
{
checkObject: 'target', // "source" | "target"
onSetObject: 'target', // "source" | "target"
onPassValue: true,
onNotPassCondition: false, // optional
fieldNameConditions: [ ]
}
],
parentFlowId:""// required
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.moveNodeProperties
** Type: object
* moveNodeProperties.sourceObject
** Type: object
** Description: return data of sourceObject
* moveRelationship.moveFieldToObject
** Type: string
** Description: return data after moveFieldToObject
* moveRelationship.movedFields
** Type: object
** Description: return data field of moveToObject
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String
=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
moveNodeProperties: {
sourceObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: {
identifiers: { },
fields: { }
}
},
moveFieldToObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: { },
fields: {

}
},
movedFields: { Fields: { } } //
}
}
},
requestParam: { },
parentFlowId: "",
status: 'complete',
errorsFound: [],
graphServiceTag: 'GraphHandler'
}
</syntaxhighlight>
[[Category:Working documents| 2025-03-06]]

2025-03-06 - Graph Handler Docs

2026-06-11T07:40:57Z

Seagame: /* MoveRelationship */

= GraphHandler Function =
== CreateNode ==
'''Use Case of CreateNode''' >>> https://izara.io/wiki/index.php/2025-03-27_Graph_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
* setFieldConditionals
** type : array
** Required : optional
* deepPathConditional
** type : array
** Required : optional
* parentFlowId
** type : string
** Required: true
* callingFlowConfig
** Type: object
** Required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType": {
"objectType": string,
"serviceTag": string
},
"objInstanceFull": {
"identifiers": {
// ...identifier
},
"fields": {
// ...fields
}
},
setFieldConditionals: [ // optional default array
{
objType: { },
indexValue: { nameSpace: 'ex-011', systemTextTag: 'Gate-011' }, // index field : value
fieldName: '', // fieldName want to set
passValue: 'false', optional
notPassValue: 'true', //optional
conditionals: [ optional ] // condition check field
}
],
"relationships": [
{
"relType": {
"serviceTag": string,
"relationshipTag": string
},
"relationshipProperties": {
//... key and value of targetIdentifiers
},
"relationshipDirection": string, // "from" | "to"
"targetObjType": {
"serviceTag": string,
"objectType": string
},
"targetIdentifiers": {
//... targetIdentifiers
}
}
],
deepPathConditional: [ // optional default array
{
condition: 'notExist', //
conditionCheck: { // traversal
nodeStructure: {
objType: { },
fields: { }
},
nextPath: {
relationshipStructure: {
relType: { },
relationshipDirection: 'to'
},
nodeStructure: {
objType: { },
fields: { }
}
}
}
}
],
"originTimestamp": number, // timestamp when create
"settings": {
"updatePropertiesOnMatch": boolean // default=false
},
"parentFlowId": "", // required
"callingFlow": string,
"callingFlowProperties": object,
}
</syntaxhighlight>

=== 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.relationships
** Type: array
** Description: data from relationships in targetNode
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* Status
** Type: string
** Description: Status from create node. Return "error" or "complete".
* errorsFound
** Type: array
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">

{
returnValue: {
queryResult: {
returnCreateNode: {
objTypes: [
{
serviceTag: "string",
objectType: "string"
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//...fields
}
},
existsNode: { },
userNode: { // // if has userNode send to createNode
objTypes: [
{
"serviceTag": "UserAccount",
"objectType": "user"
}
],
properties: {
//...properties
}
},
relationships: [ // optional : if has requiredOnCreated , createNode with targetNode
{
objTypes: [
{ serviceTag: 'string', objectType: 'string' }
],
objInstanceFull: {
identifiers: {
// identifiers
}
},
relType: {
serviceTag: 'string',
relationshipTag: 'rel'
},
relationshipProperties: {
// properties
}
},
]
}
},
requestParams: {
// return example send param
},
parentFlowId:""
},
status: "string", // "complete' or "error"
errorsFound: [],
graphServiceTag: "GraphHandler"
}

</syntaxhighlight>

== GetNode ==
'''Use Case of GetNode''' >>> https://izara.io/wiki/index.php/2025-04-23_Graph_Use_Case/GetNode_and_GetNodes#Use_Case_GetNodes
=== 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
* versionedDataLabels
** Type: Array
** Required : optional
* settings.updatePropertiesOnMatch
** Type: Boolean
** Required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":string,
"objectType":string
},
"objInstanceFull":{
"identifiers":{
// ...identifier
},
"fields":{
// ...fields
}
},
"versionedDataLabels":[
//…versionedData
],
"settings": {
"returnSystemFieldsName" :boolean // default = true or false
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* returnValue.queryResult
** Type: object
* queryResult.refactoredNodes
** Type: object
** Description: return object from getNode
* refactoredNodes.objTypes
** Type: array
* refactoredNodes.objInstanceFull
** Type: object
* refactoredNodes.objInstanceFull.identifiers
** Type: object
* refactoredNodes.objInstanceFull.fields
** Type: object
* refactoredNodes.versionDataSystemFields
** Type: object
* refactoredNodes.versionDataSystemFields.versionedDataLabel
** Type: object
* queryResult.requestParam
** Type: object
** Description: return example send param
* errorsFound
** Type: string
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
refactoredNodes: {
objTypes: [
{
serviceTag: "string",
objectType: "string",
}
],
objInstanceFull: {
identifiers: {
//… identifier
},
fields: {
//…fields
}
},
versionDataSystemFields: {
versionedDataLabel: {
originTimestamp: number,
forMatchedId: "string",
versionedDataId: "string"
}
}
}
},
requestParam: {
// return example send param
}
},
errorsFound: [],
graphServiceTag: ''
}
</syntaxhighlight>

== GetNodes ==
'''Use Case of GetNodes''' >>> https://izara.io/wiki/index.php/2025-04-23_Graph_Use_Case/GetNode_and_GetNodes#Use_Case_GetNodes
=== Request Parameters ===
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* fields
** Type : object
** Required: true
* versionedDataLabels
** Type: Array
** Required : optional
* settings.returnSystemFieldsName
** Type: Boolean
** Required : optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":string,
"objectType":string
},
"fields":{
//…fields with matching value
},
"versionedDataLabels":[
//…versionedDataLabels
],
"settings":{
"returnSystemFieldsName":boolean // default=false
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResults
** Type: object
* queryResults.getNodesReturnValues
** Type: array
* getNodesReturnValues.objTypes
** Type: array
* getNodesReturnValues.objInstanceFull
** Type: object
* getNodesReturnValues.objInstanceFull.identifiers
** Type: object
* getNodesReturnValues.objInstanceFull.fields
** Type: object
* getNodesReturnValues.versionDataSystemFields
** Type: object
* getNodesReturnValues.versionDataSystemFields.versionedDataLabel
** Type: object
* requestParams
** Type: object
* errorsFound
** Type: string
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: {
getNodesReturnValues: [
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//.. all fields-1
}
},
versionDataSystemFields: {}
},
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//...all fields-2
}
},
versionDataSystemFields: {
versionedDataLabel: {
originTimestamp: number,
forMatchedId: 'string',
versionedDataId: 'string'
}
}
}
]
},
requestParams: {
// return example send param
}
}
}
</syntaxhighlight>

== UpdateNode ==
''' Use Case of UpdateNode''' >>> https://izara.io/wiki/index.php/2025-08-03_-_Graph_Use_Case/UpdateNode
=== 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: object
** Required : true
* objInstanceFull.fields
** Type : object
** Required: true
** Description : can not send fields to update mainNode and versionedData together
* versionedDataIds
** Type: object
** Required: optional
* originTimestamp
** Type: number
** Required: true
* settings
** Type: object
** Required: optional
* parentFlowId
** type : string
** Required: true
* callingFlow
** Type: string
** Required: optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType": {
"serviceTag": string,
"objectType": string
},
"objInstanceFull": {
"identifiers": {
//…identifiers
},
"fields": {
//…fields
// can not be send fields of mainNode and versionedData in fields together!
}
},
"versionedDataIds": {},
"originTimestamp": number, //// timestamp when update
"settings": {},
"parentFlowId": ""// required
"callingFlow": string
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* returnValue.queryResult
** Type: object
** Description: data from created node
* queryResult.objTypes
** Type: array
** Description: serviceTag and objectType
* queryResult.objInstanceFull
** Type: object
** Description: identifiers and fields
* queryResult.userId
** Type: object
** Description: data that update from user Account
* queryResult.versionDataSystemFields
** Type: object
** Description: optional return versionedData
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* returnValue.Status
** Type: string
** Description: status from updated node // error or complete
* returnValue.errorsFound
** Type: array
* returnValue.graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifiers
},
fields: {
//...fields
}
},
userId: {
// if have userNode send to updated
},
versionDataSystemFields: {
versionedDataLabel: {
}
}
},
requestParams: {
// return example send param
},
parentFlowId:""
},
status: 'string',//"complete" // "error"
errorsFound: [],
graphServiceTag: 'string'
}
</syntaxhighlight>

== CreateRelationship ==
''' Use Case of CreateRelationship''' >>> https://izara.io/wiki/index.php/2025-08-01_-_Graph_Use_Case/CreateRelationship
=== Request Parameters ===
* firstObject
** Type: object
** Required: true
* secondObject
** Type: object
** Required: true
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* identifiers
** Type: object
** Required : true
* additionalRelationships
** Type: array of object
** Required: optional
* relType
** Type: object
** Required: true
* relationshipDirection
** Type: string
** Required: true
* relationshipProperties
** Type: object
** Required: true
* deepPathConditional
** Type : array
** Required: optional
** Description : using deepPathConditional for check relationship if not exist , can check on firstNode and seconNode or additionalRelationships
* Settings
** Type: object
** Required: true
* settings.updateRelPropsWhenExist
** Type: boolean
** Required: optional
* parentFlowId
** type : string
** Required: true
* callingFlow
** Type: string
** Required: optional
* callingFlowConfig
** Type: object
** Required: optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject": {
"objType": {
"serviceTag": string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"additionalRelationships": [
{
"objType": {
"serviceTag":string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"relType": {
"serviceTag":string,
"relationshipTag":string
},
"relationshipProperties": {
//…properties
},
"relationshipDirection":string ,// “from” , “to”
"deepPathConditional": []
}
]
},
"secondObject": {
"objType": {
"serviceTag":string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"additionalRelationships": [
//…optional
]
},
"relType": {
"serviceTag":string,
"relationshipTag":string
},
"relationshipDirection":string, // “from” , “to”
"relationshipProperties": {
//…properties
},
"deepPathConditional": [ // default []
{
condition: 'notExist',
conditionCheck: {
nodeStructure: {
objType: {

},
fields: { }
},
nextPath: {
relationshipStructure: {
relType: {

},
relationshipDirection: ''
},
nodeStructure: {
objType: {

},
fields: { }
}
}
}
}
]
"settings": {
"reateOnConditionalFail": false // true default = false
"updateRelPropsWhenExist": boolean,
},
"parentFlowId": "", // required
"callingFlow": "xxxx",
"callingFlowProperties": {
"graphServiceName": string
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.relationship
** Type: object
* queryResult.relationship.relType
** Type: object
* queryResult.relationship.relationshipProperties
** Type: object
* queryResult.firstNode
** Type: object
** Description: return data structure from firstNode
* queryResult.secondNode
** Type: object
** Description: return data structure from secondNode
* queryResult..onCreateAddRelationships
** Type: array
** Description: return data structure from onCreateAddRelationships
* returnValue.firstObject
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* Status
** Type: string
** Description: status from create node // error or complete
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
relationship: {
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//…properties
}
},
firstNode: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: { //… identifiers },
fields: {
//… all fields
}
},
onCreateAddRelationships: [
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//… identifiers
},
fields: {
//… all fields
}
},
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//… all properties
}
}
]
},
secondNode: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: { //… identifiers },
fields: {
//… all fields
}
},
onCreateAddRelationships: [
//… optional
]
}
}
}
}
requestParams: {
// return example send param

},
parentFlowId: "",
Status: 'string', //“complete” // “error”
errorsFound: []
}
}
</syntaxhighlight>

== GetRelationship ==
=== Request Parameters ===
* firstObject
** Type: object
** Required: optional
* secondObject
** Type: object
** Required: optional
* objType
** Type: object
** Required: true
** Description: has serviceTag and objectType
* identifiers
** Type: object
** Required: true
* relType
** Type: object
** Required: true
** Description: has relationshipTag and serviceTag
* relId
** Type: string
** Required: true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag":string,
"objectType":string
},
"identifiers":{
//…identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"relType":{ // required
"relationshipTag": string,
"serviceTag": string
},
"relId": 'string' // // required
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
* Type: object
* queryResult.relType
** Type: object
* queryResult.relationshipProperties
** Type: object
** Description: return relId and properties
* returnValue.toObject
** Type: object
** Description: return toObject if not send secondObject from param
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* errorsFound
** Type: array
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: {
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//…properties : 'string’
}
},
toObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: {
identifiers: {
//
},
fields: { }
}
},
requestParams: {
// return example send param
}
}
}

</syntaxhighlight>

== UpdateRelationship ==
=== Request Parameters ===
* firstObject
** Type: object
** Required: optional
* secondObject
** Type: object
** Required: Optional
* objType
** Type: object
** Required: true
** Description: has serviceTag and objectType
* identifiers
** Type: object
** Required: true
* relId
** Type: string
** Required: true
* relType
** Type: object
** Required: true
** Description: has relationshipTag and serviceTag
* relationshipProperties
** Type: object
** Required: true
** Description: send properties that want to update
* relationshipDirection
** Type: string
** Required: optional
* parentFlowId
** Type : string
** Required : true
* callingFlow
** Type: string
** Required: optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"relId": string,
"relType":{
"serviceTag":string,
"relationshipTag":string
},
"relationshipProperties":{
//… properties that want to update
},
"relationshipDirection": string, // "from" // “to”
"parentFlowId": ""// required
"callingFlow": string
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.firstObject And secondObject
** Type: object
** Description : return objType {seviceTag and objectType} And identifiers
* queryResult.relId
** Type: string
* queryResult.relType
** Type: object
** Description: return {seviceTag and relationshipTag}
* queryResult.relationshipDirection
** Type: string
* queryResult.updatePropertiesParam
** Type: object
** Description: return properties to updated
* queryResult.oldRelationshipProperties
** Type: object
** Description: return old properties before update
* queryResult.newRelationshipProperties
** Type: object
** Description: return new properties after updated
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type : string
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
firstObject: {
objType: {
serviceTag: "string",
objectType: "string"
},
identifiers: {
//…identifiers
}
},
secondObject: {
objType: {
serviceTag: "string",
objectType: "string"
},
identifiers: {
//…identifiers
}
},
relId: "string",
relType: {
serviceTag: "string",
relationshipTag: "string"
},
relationshipDirection: "string",
updatePropertiesParam: {
//… properties updated
},
oldRelationshipProperties: {
// … old properties before update
},
newRelationshipProperties: {
//… new properties after updated
}
}
},
requestParams: {
// return example send param
},
parentFlowId:"",
status: “string”, // "complete",”error”
errorsFound: []
}
</syntaxhighlight>

== GetNodeAndRelationship ==
=== Request Parameters ===
* sourceObjType
** Required: true
** Description: has serviceTag and objectType
* sourceIdentifiers
** Type: object
** Required: true
* sourceVersionedDataLabels
** Type: object
** Required: optional
* targetRelationships
** Type: Array
** Required: true
* relTypeAndDirection
** Type: object
** Required: true
* relTypeAndDirection.relType
** Type: object
** Required: true
** Description: has serviceTag and relationshipTag
* relTypeAndDirection.relationshipProperties
** Type: object
** Required: optional
* relTypeAndDirection.relationshipDirection
** Type: String
** Required: optional
* targetObjects
** Type: Array
** Required: Optional
* targetObjects.objType
** Type: object
** Required: required if send targetObjects in param
* targetObjects.identifiers
** Type: object
** Required: optional should have objType if identifiers exists
* targetObjects.versionedDataLabels
** Type: object
** Required: optional have objType if versionedDataLabels exists

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"sourceObjType": { // required
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"sourceIdentifiers": {}, // required
"sourceVersionedDataLabels": [], // optional
"targetRelationships": [ //required
{
"relTypeAndDirection": { // required
"relType": {
"serviceTag": "xxxx",
"relationshipTag": "rel"
},
"relationshipProperties": {},//optional
"relationshipDirection": "" // required
},
"targetObjects": [ // optional
{
"objType": {
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"identifiers": {}, // optional
"versionedDataLabels": [] // optional have objType if versionedDataLabels exists
}
]
},
// if have multiple relTypeAndDirection
],
"settings": {} // defaulf = false >>> if have versionedDataLabels want to return all field of versionedata: settings = { returnSystemFieldsName: true }
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.objTypes
** Type: array of object
** Description: return {serviceTag and objectType}
* queryResult.objInstanceFull
** Type: object
** Description: return {identifiers and fields}
* queryResult.relNodes:
** Type: array
* relNodes.relType
** Type: object
** Description: return {serviceTag and relationshipTag}
* relNodes.relationshipProperties
** Type: object
* relNodes.objTypes
** Type: array of object
** Description: return {serviceTag and objectType}
* relNodes.objInstanceFull
** Type: object
** Description: return {identifiers and fields}
* requestParams
** Type: object
** Description: return same requestParams
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: {},
fields: { }
},
relNodes: [
{
relType: {
serviceTag: 'xxxx',
relationshipTag: 'rel'
},
relationshipProperties: { },
objTypes: [
{
serviceTag: 'xxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: {},
fields: {
// field
}
},
versionDataSystemFields: {
'0VersionDataLabel': {
originTimestamp:
forMatchedId:
versionedDataId:
}
}
}
]
}
},
requestParam : {
// return example send param
},
errorsFound: [],
graphServiceTag: "GraphHandler"
}

</syntaxhighlight>

== ChangeRelationshipType ==
=== Request Parameters ===
* firstObject
** Type : object
** Required : true
* secondObject
** Type : object
** Required : true
* objType
** Type : object
** Required : true
* Identifiers
** Type : object
** Required : true
* oldRelTypeAndDirection
** Type : object
** Required : true
* oldRelTypeAndDirection.relType
** Type : object
** Required : true
* oldRelTypeAndDirection.relationshipDirection
** Type : string
** Required : true
* oldRelTypeAndDirection.relationshipProperties
** Type : object
** Required : optional
* newRelType
** Type : object
** Required : true
* originTimestamp
** Type : number
** Required : true
* changedByUserId
** Type : String
** Required : true
* settings
** Type : object
** Required : optional
** Description : default > settings.changeMultipleRelationships : false // if send settings.changeMultipleRelationships : true >> can change multiple relType
* parentFlowId
** Type: string
** required: true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"secondObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"oldRelTypeAndDirection":{
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"old"
},
"relationshipDirection":"from",
"relationshipProperties":{
//Properties
}
},
"newRelType":{
"serviceTag":"xxxx",
"relationshipTag":"new"
},
"originTimestamp":1234567890,
"changedByUserId":"xxxx",
"settings":{
"changeMultipleRelationships": boolean: // default false
},
parentFlowId: "" // required
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.newRelationshipType
** Type: object
* newRelationshipType.relType
** Type: object
* newRelationshipType.relationshipDirection
** Type: string
* newRelationshipType.relationshipProperties
** Type: object
* queryResult.oldRelationshipType
** Type: object
* oldRelationshipType.relType
** Type: object
* oldRelationshipType.relationshipDirection
** Type: string
* oldRelationshipType.relationshipProperties
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
newRelationshipType: {
relType: {
serviceTag: "xxxx",
relationshipTag: "new"
},
relationshipDirection: "" // 'from' or 'to'
relationshipProperties: {}
},
oldRelationshipType: {
relType: {
serviceTag: "xxxx",
relationshipTag: "old"
},
relationshipDirection: "" // 'from' or 'to'
relationshipProperties: {}
}
},
requestParams : {
// return example send param
}
},
status: "complete" // or error,
errorsFound: [],
graphServiceTag : 'GraphHandeler'
}

</syntaxhighlight>

== DeleteRelationship ==
=== Request Parameters ===
* fromObject
** Type : object
** Required : optional
* secondObject
** Type : object
** Required : optional
* objType
** Type : object
** Required : true
* Identifiers
** Type : object
** Required : true
* relType
** Type : object
** Required : true
* relId
** Type: string
** Required : true
* relationshipDirection
** Type: string
** Required : optional
* parentFlowId
** Type: string
** Requird: true
* callingFlow
** Type: string
** Required : true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"yyyy"
},
"relId":"string"
},
"relationshipDirection":"string"// "from" or "to"
"parentFlowIf": "", // required
"callingFlow":"string"
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.objects
** Type: array
* queryResult.objTypes
** Type: array
* queryResult.objInstanceFull.identifiers
** Type: object
* queryResult.objInstanceFull.fields
** Type: object
** Description: return data of fromObject and secondObject
* queryResult.userNode
** Type: object
** Description: return data of userNode
* queryResult.resultDeleteRel
** Type : string
** Description: return status Relationship Delete
* requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objects: [
{
objTypes: [
{
serviceTag: "xxxx",
objectType: "yyyy"
}
],
objInstanceFull: {
identifiers: {
// identifiers
},
fields: {
// fields
}
}
},
{
// if have multiple object objTypes
}
],
userNode: {
objTypes: [
{
serviceTag: "UserAccount",
objectType: "user"
}
],
objInstanceFull: {
identifiers: {
userId: "zzz"
}
}
},
resultDeleteRel: "Relationship Deleted" // default
},
requeatParam: {
// return example send param
},
status: "string", //default "complete" or "error"
errorsFound: []
}
}

</syntaxhighlight>

== DeleteNode ==
=== Request Parameters ===
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* identifiers
** Type : object
** Required: true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":"xxx",
"objectType":"yyy"
},
"identifiers":{
//
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResults
** Type: object
* queryResults.resultDeleteNode
** Type: Boolean
** Description: return status deleted node >> true or false
* requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
** Description: return status deleted node >> complete or error
* errorsFound
** Type: array
* graphServiceTag
** Type: string
=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: { resultDeleteNode: true }, // true or false
requestParams: {
// return example send param
}
},
status: 'string', // 'complete' or 'error'
errorsFound: [],
graphServiceTag: 'GraphHandler'
}
</syntaxhighlight>

== MoveRelationship ==

=== Request Parameters ===
* sourceObject
** Type : object
** Required : true
** Description: required objType: {serviceTag , objectType} and identifiers
* targetObjType
** Type : object
** Required : true
** Description: required objType: {serviceTag , objectType}
* relType
** Type : object
** Required : true
** Description: required objType: {serviceTag , relationshipTag}
* relationshipDirection
** Type : object
** Required : true
* moveToIdentifiers
** Type : object
** Required : true
* moveByUserId
** Type : String
** Required : true
* originTimestamp
** Type : number
** Required : true
* settings
** Type : object
** Required : optional // default {}
* parentFlowId
** Type: string
** Requied: true
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"sourceObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyy"
},
"identifiers":{
// identifiers
}
},
"targetObjType":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
}
},
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"rel"
},
"relationshipDirection":"from", // "to"
"moveToIdentifiers":{
// target identifiers
},
"moveByUserId":"xxxx",
"originTimestamp":1234567890,
"settings":{},
"parentFlowId": "" // required
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.moveRelationship
** Type: object
* moveRelationship.sourceObject
** Type: object
** Description: return data of sourceObject
* moveRelationship.relationship
** Type: string
** Description: return data of after move relationship
* moveRelationship.moveToObject
** Type: object
** Description: return data of moveToObject
* moveRelationship.historyData
** Type: object
** Description: return properties {old target identifiers and originTimestamp} after moveRelationship
* moveRelationship.userNode
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
moveRelationship: {
sourceObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
}
},
relationship: {
relType: {
serviceTag: 'xxxx',
relationshipTag: 'rel'
},
relationshipProperties: { originTimestamp: 1234567890 }
},
moveToObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: { }
},
historyData: {
relationshipProperties: { }
},
userNode: {
objTypes: [{ serviceTag: 'UserAccount', objectType: 'user' }],
objInstanceFull: { }
}
}
},
requestParam: {
},
parentFlowId:""
}
status: "complete" // or error,
errorsFound: [],
graphServiceTag: 'GraphHandler'
}

</syntaxhighlight>

== MoveNodeProperties ==
=== Request Parameters ===
* sourceObject
** type: object
** required : true
* targetIdentifiers
** type : object
** required : true
* moveProperties
** type : array
** required : true // index minimum = 1
* updateProperties
** type : object
** required : true
* movePropertiesConditions
** type : array
** required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
sourceObject: {
objType: { },
identifier: { }
},
targetIdentifiers: { },
moveProperties: [ ],
updateProperties: { },
movePropertiesConditions: [ // optional
{
checkObject: 'target', // "source" | "target"
onSetObject: 'target', // "source" | "target"
onPassValue: true,
onNotPassCondition: false, // optional
fieldNameConditions: [ ]
}
]
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.moveNodeProperties
** Type: object
* moveNodeProperties.sourceObject
** Type: object
** Description: return data of sourceObject
* moveRelationship.moveFieldToObject
** Type: string
** Description: return data after moveFieldToObject
* moveRelationship.movedFields
** Type: object
** Description: return data field of moveToObject
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String
=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
moveNodeProperties: {
sourceObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: {
identifiers: { },
fields: { }
}
},
moveFieldToObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: { },
fields: {

}
},
movedFields: { Fields: { } } //
}
}
},
requestParam: { },
status: 'complete',
errorsFound: [],
graphServiceTag: 'GraphHandler'
}
</syntaxhighlight>
[[Category:Working documents| 2025-03-06]]

2025-03-06 - Graph Handler Docs

2026-06-11T07:38:17Z

Seagame: /* MoveRelationship */

= GraphHandler Function =
== CreateNode ==
'''Use Case of CreateNode''' >>> https://izara.io/wiki/index.php/2025-03-27_Graph_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
* setFieldConditionals
** type : array
** Required : optional
* deepPathConditional
** type : array
** Required : optional
* parentFlowId
** type : string
** Required: true
* callingFlowConfig
** Type: object
** Required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType": {
"objectType": string,
"serviceTag": string
},
"objInstanceFull": {
"identifiers": {
// ...identifier
},
"fields": {
// ...fields
}
},
setFieldConditionals: [ // optional default array
{
objType: { },
indexValue: { nameSpace: 'ex-011', systemTextTag: 'Gate-011' }, // index field : value
fieldName: '', // fieldName want to set
passValue: 'false', optional
notPassValue: 'true', //optional
conditionals: [ optional ] // condition check field
}
],
"relationships": [
{
"relType": {
"serviceTag": string,
"relationshipTag": string
},
"relationshipProperties": {
//... key and value of targetIdentifiers
},
"relationshipDirection": string, // "from" | "to"
"targetObjType": {
"serviceTag": string,
"objectType": string
},
"targetIdentifiers": {
//... targetIdentifiers
}
}
],
deepPathConditional: [ // optional default array
{
condition: 'notExist', //
conditionCheck: { // traversal
nodeStructure: {
objType: { },
fields: { }
},
nextPath: {
relationshipStructure: {
relType: { },
relationshipDirection: 'to'
},
nodeStructure: {
objType: { },
fields: { }
}
}
}
}
],
"originTimestamp": number, // timestamp when create
"settings": {
"updatePropertiesOnMatch": boolean // default=false
},
"parentFlowId": "", // required
"callingFlow": string,
"callingFlowProperties": object,
}
</syntaxhighlight>

=== 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.relationships
** Type: array
** Description: data from relationships in targetNode
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* Status
** Type: string
** Description: Status from create node. Return "error" or "complete".
* errorsFound
** Type: array
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">

{
returnValue: {
queryResult: {
returnCreateNode: {
objTypes: [
{
serviceTag: "string",
objectType: "string"
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//...fields
}
},
existsNode: { },
userNode: { // // if has userNode send to createNode
objTypes: [
{
"serviceTag": "UserAccount",
"objectType": "user"
}
],
properties: {
//...properties
}
},
relationships: [ // optional : if has requiredOnCreated , createNode with targetNode
{
objTypes: [
{ serviceTag: 'string', objectType: 'string' }
],
objInstanceFull: {
identifiers: {
// identifiers
}
},
relType: {
serviceTag: 'string',
relationshipTag: 'rel'
},
relationshipProperties: {
// properties
}
},
]
}
},
requestParams: {
// return example send param
},
parentFlowId:""
},
status: "string", // "complete' or "error"
errorsFound: [],
graphServiceTag: "GraphHandler"
}

</syntaxhighlight>

== GetNode ==
'''Use Case of GetNode''' >>> https://izara.io/wiki/index.php/2025-04-23_Graph_Use_Case/GetNode_and_GetNodes#Use_Case_GetNodes
=== 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
* versionedDataLabels
** Type: Array
** Required : optional
* settings.updatePropertiesOnMatch
** Type: Boolean
** Required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":string,
"objectType":string
},
"objInstanceFull":{
"identifiers":{
// ...identifier
},
"fields":{
// ...fields
}
},
"versionedDataLabels":[
//…versionedData
],
"settings": {
"returnSystemFieldsName" :boolean // default = true or false
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* returnValue.queryResult
** Type: object
* queryResult.refactoredNodes
** Type: object
** Description: return object from getNode
* refactoredNodes.objTypes
** Type: array
* refactoredNodes.objInstanceFull
** Type: object
* refactoredNodes.objInstanceFull.identifiers
** Type: object
* refactoredNodes.objInstanceFull.fields
** Type: object
* refactoredNodes.versionDataSystemFields
** Type: object
* refactoredNodes.versionDataSystemFields.versionedDataLabel
** Type: object
* queryResult.requestParam
** Type: object
** Description: return example send param
* errorsFound
** Type: string
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
refactoredNodes: {
objTypes: [
{
serviceTag: "string",
objectType: "string",
}
],
objInstanceFull: {
identifiers: {
//… identifier
},
fields: {
//…fields
}
},
versionDataSystemFields: {
versionedDataLabel: {
originTimestamp: number,
forMatchedId: "string",
versionedDataId: "string"
}
}
}
},
requestParam: {
// return example send param
}
},
errorsFound: [],
graphServiceTag: ''
}
</syntaxhighlight>

== GetNodes ==
'''Use Case of GetNodes''' >>> https://izara.io/wiki/index.php/2025-04-23_Graph_Use_Case/GetNode_and_GetNodes#Use_Case_GetNodes
=== Request Parameters ===
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* fields
** Type : object
** Required: true
* versionedDataLabels
** Type: Array
** Required : optional
* settings.returnSystemFieldsName
** Type: Boolean
** Required : optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":string,
"objectType":string
},
"fields":{
//…fields with matching value
},
"versionedDataLabels":[
//…versionedDataLabels
],
"settings":{
"returnSystemFieldsName":boolean // default=false
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResults
** Type: object
* queryResults.getNodesReturnValues
** Type: array
* getNodesReturnValues.objTypes
** Type: array
* getNodesReturnValues.objInstanceFull
** Type: object
* getNodesReturnValues.objInstanceFull.identifiers
** Type: object
* getNodesReturnValues.objInstanceFull.fields
** Type: object
* getNodesReturnValues.versionDataSystemFields
** Type: object
* getNodesReturnValues.versionDataSystemFields.versionedDataLabel
** Type: object
* requestParams
** Type: object
* errorsFound
** Type: string
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: {
getNodesReturnValues: [
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//.. all fields-1
}
},
versionDataSystemFields: {}
},
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//...all fields-2
}
},
versionDataSystemFields: {
versionedDataLabel: {
originTimestamp: number,
forMatchedId: 'string',
versionedDataId: 'string'
}
}
}
]
},
requestParams: {
// return example send param
}
}
}
</syntaxhighlight>

== UpdateNode ==
''' Use Case of UpdateNode''' >>> https://izara.io/wiki/index.php/2025-08-03_-_Graph_Use_Case/UpdateNode
=== 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: object
** Required : true
* objInstanceFull.fields
** Type : object
** Required: true
** Description : can not send fields to update mainNode and versionedData together
* versionedDataIds
** Type: object
** Required: optional
* originTimestamp
** Type: number
** Required: true
* settings
** Type: object
** Required: optional
* parentFlowId
** type : string
** Required: true
* callingFlow
** Type: string
** Required: optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType": {
"serviceTag": string,
"objectType": string
},
"objInstanceFull": {
"identifiers": {
//…identifiers
},
"fields": {
//…fields
// can not be send fields of mainNode and versionedData in fields together!
}
},
"versionedDataIds": {},
"originTimestamp": number, //// timestamp when update
"settings": {},
"parentFlowId": ""// required
"callingFlow": string
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* returnValue.queryResult
** Type: object
** Description: data from created node
* queryResult.objTypes
** Type: array
** Description: serviceTag and objectType
* queryResult.objInstanceFull
** Type: object
** Description: identifiers and fields
* queryResult.userId
** Type: object
** Description: data that update from user Account
* queryResult.versionDataSystemFields
** Type: object
** Description: optional return versionedData
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* returnValue.Status
** Type: string
** Description: status from updated node // error or complete
* returnValue.errorsFound
** Type: array
* returnValue.graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifiers
},
fields: {
//...fields
}
},
userId: {
// if have userNode send to updated
},
versionDataSystemFields: {
versionedDataLabel: {
}
}
},
requestParams: {
// return example send param
},
parentFlowId:""
},
status: 'string',//"complete" // "error"
errorsFound: [],
graphServiceTag: 'string'
}
</syntaxhighlight>

== CreateRelationship ==
''' Use Case of CreateRelationship''' >>> https://izara.io/wiki/index.php/2025-08-01_-_Graph_Use_Case/CreateRelationship
=== Request Parameters ===
* firstObject
** Type: object
** Required: true
* secondObject
** Type: object
** Required: true
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* identifiers
** Type: object
** Required : true
* additionalRelationships
** Type: array of object
** Required: optional
* relType
** Type: object
** Required: true
* relationshipDirection
** Type: string
** Required: true
* relationshipProperties
** Type: object
** Required: true
* deepPathConditional
** Type : array
** Required: optional
** Description : using deepPathConditional for check relationship if not exist , can check on firstNode and seconNode or additionalRelationships
* Settings
** Type: object
** Required: true
* settings.updateRelPropsWhenExist
** Type: boolean
** Required: optional
* parentFlowId
** type : string
** Required: true
* callingFlow
** Type: string
** Required: optional
* callingFlowConfig
** Type: object
** Required: optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject": {
"objType": {
"serviceTag": string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"additionalRelationships": [
{
"objType": {
"serviceTag":string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"relType": {
"serviceTag":string,
"relationshipTag":string
},
"relationshipProperties": {
//…properties
},
"relationshipDirection":string ,// “from” , “to”
"deepPathConditional": []
}
]
},
"secondObject": {
"objType": {
"serviceTag":string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"additionalRelationships": [
//…optional
]
},
"relType": {
"serviceTag":string,
"relationshipTag":string
},
"relationshipDirection":string, // “from” , “to”
"relationshipProperties": {
//…properties
},
"deepPathConditional": [ // default []
{
condition: 'notExist',
conditionCheck: {
nodeStructure: {
objType: {

},
fields: { }
},
nextPath: {
relationshipStructure: {
relType: {

},
relationshipDirection: ''
},
nodeStructure: {
objType: {

},
fields: { }
}
}
}
}
]
"settings": {
"reateOnConditionalFail": false // true default = false
"updateRelPropsWhenExist": boolean,
},
"parentFlowId": "", // required
"callingFlow": "xxxx",
"callingFlowProperties": {
"graphServiceName": string
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.relationship
** Type: object
* queryResult.relationship.relType
** Type: object
* queryResult.relationship.relationshipProperties
** Type: object
* queryResult.firstNode
** Type: object
** Description: return data structure from firstNode
* queryResult.secondNode
** Type: object
** Description: return data structure from secondNode
* queryResult..onCreateAddRelationships
** Type: array
** Description: return data structure from onCreateAddRelationships
* returnValue.firstObject
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* Status
** Type: string
** Description: status from create node // error or complete
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
relationship: {
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//…properties
}
},
firstNode: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: { //… identifiers },
fields: {
//… all fields
}
},
onCreateAddRelationships: [
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//… identifiers
},
fields: {
//… all fields
}
},
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//… all properties
}
}
]
},
secondNode: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: { //… identifiers },
fields: {
//… all fields
}
},
onCreateAddRelationships: [
//… optional
]
}
}
}
}
requestParams: {
// return example send param

},
parentFlowId: "",
Status: 'string', //“complete” // “error”
errorsFound: []
}
}
</syntaxhighlight>

== GetRelationship ==
=== Request Parameters ===
* firstObject
** Type: object
** Required: optional
* secondObject
** Type: object
** Required: optional
* objType
** Type: object
** Required: true
** Description: has serviceTag and objectType
* identifiers
** Type: object
** Required: true
* relType
** Type: object
** Required: true
** Description: has relationshipTag and serviceTag
* relId
** Type: string
** Required: true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag":string,
"objectType":string
},
"identifiers":{
//…identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"relType":{ // required
"relationshipTag": string,
"serviceTag": string
},
"relId": 'string' // // required
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
* Type: object
* queryResult.relType
** Type: object
* queryResult.relationshipProperties
** Type: object
** Description: return relId and properties
* returnValue.toObject
** Type: object
** Description: return toObject if not send secondObject from param
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* errorsFound
** Type: array
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: {
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//…properties : 'string’
}
},
toObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: {
identifiers: {
//
},
fields: { }
}
},
requestParams: {
// return example send param
}
}
}

</syntaxhighlight>

== UpdateRelationship ==
=== Request Parameters ===
* firstObject
** Type: object
** Required: optional
* secondObject
** Type: object
** Required: Optional
* objType
** Type: object
** Required: true
** Description: has serviceTag and objectType
* identifiers
** Type: object
** Required: true
* relId
** Type: string
** Required: true
* relType
** Type: object
** Required: true
** Description: has relationshipTag and serviceTag
* relationshipProperties
** Type: object
** Required: true
** Description: send properties that want to update
* relationshipDirection
** Type: string
** Required: optional
* parentFlowId
** Type : string
** Required : true
* callingFlow
** Type: string
** Required: optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"relId": string,
"relType":{
"serviceTag":string,
"relationshipTag":string
},
"relationshipProperties":{
//… properties that want to update
},
"relationshipDirection": string, // "from" // “to”
"parentFlowId": ""// required
"callingFlow": string
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.firstObject And secondObject
** Type: object
** Description : return objType {seviceTag and objectType} And identifiers
* queryResult.relId
** Type: string
* queryResult.relType
** Type: object
** Description: return {seviceTag and relationshipTag}
* queryResult.relationshipDirection
** Type: string
* queryResult.updatePropertiesParam
** Type: object
** Description: return properties to updated
* queryResult.oldRelationshipProperties
** Type: object
** Description: return old properties before update
* queryResult.newRelationshipProperties
** Type: object
** Description: return new properties after updated
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type : string
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
firstObject: {
objType: {
serviceTag: "string",
objectType: "string"
},
identifiers: {
//…identifiers
}
},
secondObject: {
objType: {
serviceTag: "string",
objectType: "string"
},
identifiers: {
//…identifiers
}
},
relId: "string",
relType: {
serviceTag: "string",
relationshipTag: "string"
},
relationshipDirection: "string",
updatePropertiesParam: {
//… properties updated
},
oldRelationshipProperties: {
// … old properties before update
},
newRelationshipProperties: {
//… new properties after updated
}
}
},
requestParams: {
// return example send param
},
parentFlowId:"",
status: “string”, // "complete",”error”
errorsFound: []
}
</syntaxhighlight>

== GetNodeAndRelationship ==
=== Request Parameters ===
* sourceObjType
** Required: true
** Description: has serviceTag and objectType
* sourceIdentifiers
** Type: object
** Required: true
* sourceVersionedDataLabels
** Type: object
** Required: optional
* targetRelationships
** Type: Array
** Required: true
* relTypeAndDirection
** Type: object
** Required: true
* relTypeAndDirection.relType
** Type: object
** Required: true
** Description: has serviceTag and relationshipTag
* relTypeAndDirection.relationshipProperties
** Type: object
** Required: optional
* relTypeAndDirection.relationshipDirection
** Type: String
** Required: optional
* targetObjects
** Type: Array
** Required: Optional
* targetObjects.objType
** Type: object
** Required: required if send targetObjects in param
* targetObjects.identifiers
** Type: object
** Required: optional should have objType if identifiers exists
* targetObjects.versionedDataLabels
** Type: object
** Required: optional have objType if versionedDataLabels exists

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"sourceObjType": { // required
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"sourceIdentifiers": {}, // required
"sourceVersionedDataLabels": [], // optional
"targetRelationships": [ //required
{
"relTypeAndDirection": { // required
"relType": {
"serviceTag": "xxxx",
"relationshipTag": "rel"
},
"relationshipProperties": {},//optional
"relationshipDirection": "" // required
},
"targetObjects": [ // optional
{
"objType": {
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"identifiers": {}, // optional
"versionedDataLabels": [] // optional have objType if versionedDataLabels exists
}
]
},
// if have multiple relTypeAndDirection
],
"settings": {} // defaulf = false >>> if have versionedDataLabels want to return all field of versionedata: settings = { returnSystemFieldsName: true }
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.objTypes
** Type: array of object
** Description: return {serviceTag and objectType}
* queryResult.objInstanceFull
** Type: object
** Description: return {identifiers and fields}
* queryResult.relNodes:
** Type: array
* relNodes.relType
** Type: object
** Description: return {serviceTag and relationshipTag}
* relNodes.relationshipProperties
** Type: object
* relNodes.objTypes
** Type: array of object
** Description: return {serviceTag and objectType}
* relNodes.objInstanceFull
** Type: object
** Description: return {identifiers and fields}
* requestParams
** Type: object
** Description: return same requestParams
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: {},
fields: { }
},
relNodes: [
{
relType: {
serviceTag: 'xxxx',
relationshipTag: 'rel'
},
relationshipProperties: { },
objTypes: [
{
serviceTag: 'xxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: {},
fields: {
// field
}
},
versionDataSystemFields: {
'0VersionDataLabel': {
originTimestamp:
forMatchedId:
versionedDataId:
}
}
}
]
}
},
requestParam : {
// return example send param
},
errorsFound: [],
graphServiceTag: "GraphHandler"
}

</syntaxhighlight>

== ChangeRelationshipType ==
=== Request Parameters ===
* firstObject
** Type : object
** Required : true
* secondObject
** Type : object
** Required : true
* objType
** Type : object
** Required : true
* Identifiers
** Type : object
** Required : true
* oldRelTypeAndDirection
** Type : object
** Required : true
* oldRelTypeAndDirection.relType
** Type : object
** Required : true
* oldRelTypeAndDirection.relationshipDirection
** Type : string
** Required : true
* oldRelTypeAndDirection.relationshipProperties
** Type : object
** Required : optional
* newRelType
** Type : object
** Required : true
* originTimestamp
** Type : number
** Required : true
* changedByUserId
** Type : String
** Required : true
* settings
** Type : object
** Required : optional
** Description : default > settings.changeMultipleRelationships : false // if send settings.changeMultipleRelationships : true >> can change multiple relType
* parentFlowId
** Type: string
** required: true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"secondObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"oldRelTypeAndDirection":{
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"old"
},
"relationshipDirection":"from",
"relationshipProperties":{
//Properties
}
},
"newRelType":{
"serviceTag":"xxxx",
"relationshipTag":"new"
},
"originTimestamp":1234567890,
"changedByUserId":"xxxx",
"settings":{
"changeMultipleRelationships": boolean: // default false
},
parentFlowId: "" // required
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.newRelationshipType
** Type: object
* newRelationshipType.relType
** Type: object
* newRelationshipType.relationshipDirection
** Type: string
* newRelationshipType.relationshipProperties
** Type: object
* queryResult.oldRelationshipType
** Type: object
* oldRelationshipType.relType
** Type: object
* oldRelationshipType.relationshipDirection
** Type: string
* oldRelationshipType.relationshipProperties
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
newRelationshipType: {
relType: {
serviceTag: "xxxx",
relationshipTag: "new"
},
relationshipDirection: "" // 'from' or 'to'
relationshipProperties: {}
},
oldRelationshipType: {
relType: {
serviceTag: "xxxx",
relationshipTag: "old"
},
relationshipDirection: "" // 'from' or 'to'
relationshipProperties: {}
}
},
requestParams : {
// return example send param
}
},
status: "complete" // or error,
errorsFound: [],
graphServiceTag : 'GraphHandeler'
}

</syntaxhighlight>

== DeleteRelationship ==
=== Request Parameters ===
* fromObject
** Type : object
** Required : optional
* secondObject
** Type : object
** Required : optional
* objType
** Type : object
** Required : true
* Identifiers
** Type : object
** Required : true
* relType
** Type : object
** Required : true
* relId
** Type: string
** Required : true
* relationshipDirection
** Type: string
** Required : optional
* parentFlowId
** Type: string
** Requird: true
* callingFlow
** Type: string
** Required : true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"yyyy"
},
"relId":"string"
},
"relationshipDirection":"string"// "from" or "to"
"parentFlowIf": "", // required
"callingFlow":"string"
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.objects
** Type: array
* queryResult.objTypes
** Type: array
* queryResult.objInstanceFull.identifiers
** Type: object
* queryResult.objInstanceFull.fields
** Type: object
** Description: return data of fromObject and secondObject
* queryResult.userNode
** Type: object
** Description: return data of userNode
* queryResult.resultDeleteRel
** Type : string
** Description: return status Relationship Delete
* requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objects: [
{
objTypes: [
{
serviceTag: "xxxx",
objectType: "yyyy"
}
],
objInstanceFull: {
identifiers: {
// identifiers
},
fields: {
// fields
}
}
},
{
// if have multiple object objTypes
}
],
userNode: {
objTypes: [
{
serviceTag: "UserAccount",
objectType: "user"
}
],
objInstanceFull: {
identifiers: {
userId: "zzz"
}
}
},
resultDeleteRel: "Relationship Deleted" // default
},
requeatParam: {
// return example send param
},
status: "string", //default "complete" or "error"
errorsFound: []
}
}

</syntaxhighlight>

== DeleteNode ==
=== Request Parameters ===
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* identifiers
** Type : object
** Required: true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":"xxx",
"objectType":"yyy"
},
"identifiers":{
//
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResults
** Type: object
* queryResults.resultDeleteNode
** Type: Boolean
** Description: return status deleted node >> true or false
* requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
** Description: return status deleted node >> complete or error
* errorsFound
** Type: array
* graphServiceTag
** Type: string
=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: { resultDeleteNode: true }, // true or false
requestParams: {
// return example send param
}
},
status: 'string', // 'complete' or 'error'
errorsFound: [],
graphServiceTag: 'GraphHandler'
}
</syntaxhighlight>

== MoveRelationship ==

=== Request Parameters ===
* sourceObject
** Type : object
** Required : true
** Description: required objType: {serviceTag , objectType} and identifiers
* targetObjType
** Type : object
** Required : true
** Description: required objType: {serviceTag , objectType}
* relType
** Type : object
** Required : true
** Description: required objType: {serviceTag , relationshipTag}
* relationshipDirection
** Type : object
** Required : true
* moveToIdentifiers
** Type : object
** Required : true
* moveByUserId
** Type : String
** Required : true
* originTimestamp
** Type : number
** Required : true
* settings
** Type : object
** Required : optional // default {}
* parentFlowId
** Type: string
** Requied: true
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"sourceObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyy"
},
"identifiers":{
// identifiers
}
},
"targetObjType":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
}
},
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"rel"
},
"relationshipDirection":"from", // "to"
"moveToIdentifiers":{
// target identifiers
},
"moveByUserId":"xxxx",
"originTimestamp":1234567890,
"settings":{},
"parentFlowId": "" // required
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.moveRelationship
** Type: object
* moveRelationship.sourceObject
** Type: object
** Description: return data of sourceObject
* moveRelationship.relationship
** Type: string
** Description: return data of after move relationship
* moveRelationship.moveToObject
** Type: object
** Description: return data of moveToObject
* moveRelationship.historyData
** Type: object
** Description: return properties {old target identifiers and originTimestamp} after moveRelationship
* moveRelationship.userNode
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
moveRelationship: {
sourceObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
}
},
relationship: {
relType: {
serviceTag: 'xxxx',
relationshipTag: 'rel'
},
relationshipProperties: { originTimestamp: 1234567890 }
},
moveToObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: { }
},
historyData: {
relationshipProperties: { }
},
userNode: {
objTypes: [{ serviceTag: 'UserAccount', objectType: 'user' }],
objInstanceFull: { }
}
}
},
requestParam: {
}
}
status: "complete" // or error,
errorsFound: [],
graphServiceTag: 'GraphHandler'
}

</syntaxhighlight>

== MoveNodeProperties ==
=== Request Parameters ===
* sourceObject
** type: object
** required : true
* targetIdentifiers
** type : object
** required : true
* moveProperties
** type : array
** required : true // index minimum = 1
* updateProperties
** type : object
** required : true
* movePropertiesConditions
** type : array
** required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
sourceObject: {
objType: { },
identifier: { }
},
targetIdentifiers: { },
moveProperties: [ ],
updateProperties: { },
movePropertiesConditions: [ // optional
{
checkObject: 'target', // "source" | "target"
onSetObject: 'target', // "source" | "target"
onPassValue: true,
onNotPassCondition: false, // optional
fieldNameConditions: [ ]
}
]
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.moveNodeProperties
** Type: object
* moveNodeProperties.sourceObject
** Type: object
** Description: return data of sourceObject
* moveRelationship.moveFieldToObject
** Type: string
** Description: return data after moveFieldToObject
* moveRelationship.movedFields
** Type: object
** Description: return data field of moveToObject
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String
=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
moveNodeProperties: {
sourceObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: {
identifiers: { },
fields: { }
}
},
moveFieldToObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: { },
fields: {

}
},
movedFields: { Fields: { } } //
}
}
},
requestParam: { },
status: 'complete',
errorsFound: [],
graphServiceTag: 'GraphHandler'
}
</syntaxhighlight>
[[Category:Working documents| 2025-03-06]]

2025-03-06 - Graph Handler Docs

2026-06-11T07:34:43Z

Seagame: /* DeleteRelationship */

= GraphHandler Function =
== CreateNode ==
'''Use Case of CreateNode''' >>> https://izara.io/wiki/index.php/2025-03-27_Graph_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
* setFieldConditionals
** type : array
** Required : optional
* deepPathConditional
** type : array
** Required : optional
* parentFlowId
** type : string
** Required: true
* callingFlowConfig
** Type: object
** Required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType": {
"objectType": string,
"serviceTag": string
},
"objInstanceFull": {
"identifiers": {
// ...identifier
},
"fields": {
// ...fields
}
},
setFieldConditionals: [ // optional default array
{
objType: { },
indexValue: { nameSpace: 'ex-011', systemTextTag: 'Gate-011' }, // index field : value
fieldName: '', // fieldName want to set
passValue: 'false', optional
notPassValue: 'true', //optional
conditionals: [ optional ] // condition check field
}
],
"relationships": [
{
"relType": {
"serviceTag": string,
"relationshipTag": string
},
"relationshipProperties": {
//... key and value of targetIdentifiers
},
"relationshipDirection": string, // "from" | "to"
"targetObjType": {
"serviceTag": string,
"objectType": string
},
"targetIdentifiers": {
//... targetIdentifiers
}
}
],
deepPathConditional: [ // optional default array
{
condition: 'notExist', //
conditionCheck: { // traversal
nodeStructure: {
objType: { },
fields: { }
},
nextPath: {
relationshipStructure: {
relType: { },
relationshipDirection: 'to'
},
nodeStructure: {
objType: { },
fields: { }
}
}
}
}
],
"originTimestamp": number, // timestamp when create
"settings": {
"updatePropertiesOnMatch": boolean // default=false
},
"parentFlowId": "", // required
"callingFlow": string,
"callingFlowProperties": object,
}
</syntaxhighlight>

=== 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.relationships
** Type: array
** Description: data from relationships in targetNode
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* Status
** Type: string
** Description: Status from create node. Return "error" or "complete".
* errorsFound
** Type: array
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">

{
returnValue: {
queryResult: {
returnCreateNode: {
objTypes: [
{
serviceTag: "string",
objectType: "string"
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//...fields
}
},
existsNode: { },
userNode: { // // if has userNode send to createNode
objTypes: [
{
"serviceTag": "UserAccount",
"objectType": "user"
}
],
properties: {
//...properties
}
},
relationships: [ // optional : if has requiredOnCreated , createNode with targetNode
{
objTypes: [
{ serviceTag: 'string', objectType: 'string' }
],
objInstanceFull: {
identifiers: {
// identifiers
}
},
relType: {
serviceTag: 'string',
relationshipTag: 'rel'
},
relationshipProperties: {
// properties
}
},
]
}
},
requestParams: {
// return example send param
},
parentFlowId:""
},
status: "string", // "complete' or "error"
errorsFound: [],
graphServiceTag: "GraphHandler"
}

</syntaxhighlight>

== GetNode ==
'''Use Case of GetNode''' >>> https://izara.io/wiki/index.php/2025-04-23_Graph_Use_Case/GetNode_and_GetNodes#Use_Case_GetNodes
=== 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
* versionedDataLabels
** Type: Array
** Required : optional
* settings.updatePropertiesOnMatch
** Type: Boolean
** Required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":string,
"objectType":string
},
"objInstanceFull":{
"identifiers":{
// ...identifier
},
"fields":{
// ...fields
}
},
"versionedDataLabels":[
//…versionedData
],
"settings": {
"returnSystemFieldsName" :boolean // default = true or false
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* returnValue.queryResult
** Type: object
* queryResult.refactoredNodes
** Type: object
** Description: return object from getNode
* refactoredNodes.objTypes
** Type: array
* refactoredNodes.objInstanceFull
** Type: object
* refactoredNodes.objInstanceFull.identifiers
** Type: object
* refactoredNodes.objInstanceFull.fields
** Type: object
* refactoredNodes.versionDataSystemFields
** Type: object
* refactoredNodes.versionDataSystemFields.versionedDataLabel
** Type: object
* queryResult.requestParam
** Type: object
** Description: return example send param
* errorsFound
** Type: string
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
refactoredNodes: {
objTypes: [
{
serviceTag: "string",
objectType: "string",
}
],
objInstanceFull: {
identifiers: {
//… identifier
},
fields: {
//…fields
}
},
versionDataSystemFields: {
versionedDataLabel: {
originTimestamp: number,
forMatchedId: "string",
versionedDataId: "string"
}
}
}
},
requestParam: {
// return example send param
}
},
errorsFound: [],
graphServiceTag: ''
}
</syntaxhighlight>

== GetNodes ==
'''Use Case of GetNodes''' >>> https://izara.io/wiki/index.php/2025-04-23_Graph_Use_Case/GetNode_and_GetNodes#Use_Case_GetNodes
=== Request Parameters ===
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* fields
** Type : object
** Required: true
* versionedDataLabels
** Type: Array
** Required : optional
* settings.returnSystemFieldsName
** Type: Boolean
** Required : optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":string,
"objectType":string
},
"fields":{
//…fields with matching value
},
"versionedDataLabels":[
//…versionedDataLabels
],
"settings":{
"returnSystemFieldsName":boolean // default=false
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResults
** Type: object
* queryResults.getNodesReturnValues
** Type: array
* getNodesReturnValues.objTypes
** Type: array
* getNodesReturnValues.objInstanceFull
** Type: object
* getNodesReturnValues.objInstanceFull.identifiers
** Type: object
* getNodesReturnValues.objInstanceFull.fields
** Type: object
* getNodesReturnValues.versionDataSystemFields
** Type: object
* getNodesReturnValues.versionDataSystemFields.versionedDataLabel
** Type: object
* requestParams
** Type: object
* errorsFound
** Type: string
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: {
getNodesReturnValues: [
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//.. all fields-1
}
},
versionDataSystemFields: {}
},
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//...all fields-2
}
},
versionDataSystemFields: {
versionedDataLabel: {
originTimestamp: number,
forMatchedId: 'string',
versionedDataId: 'string'
}
}
}
]
},
requestParams: {
// return example send param
}
}
}
</syntaxhighlight>

== UpdateNode ==
''' Use Case of UpdateNode''' >>> https://izara.io/wiki/index.php/2025-08-03_-_Graph_Use_Case/UpdateNode
=== 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: object
** Required : true
* objInstanceFull.fields
** Type : object
** Required: true
** Description : can not send fields to update mainNode and versionedData together
* versionedDataIds
** Type: object
** Required: optional
* originTimestamp
** Type: number
** Required: true
* settings
** Type: object
** Required: optional
* parentFlowId
** type : string
** Required: true
* callingFlow
** Type: string
** Required: optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType": {
"serviceTag": string,
"objectType": string
},
"objInstanceFull": {
"identifiers": {
//…identifiers
},
"fields": {
//…fields
// can not be send fields of mainNode and versionedData in fields together!
}
},
"versionedDataIds": {},
"originTimestamp": number, //// timestamp when update
"settings": {},
"parentFlowId": ""// required
"callingFlow": string
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* returnValue.queryResult
** Type: object
** Description: data from created node
* queryResult.objTypes
** Type: array
** Description: serviceTag and objectType
* queryResult.objInstanceFull
** Type: object
** Description: identifiers and fields
* queryResult.userId
** Type: object
** Description: data that update from user Account
* queryResult.versionDataSystemFields
** Type: object
** Description: optional return versionedData
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* returnValue.Status
** Type: string
** Description: status from updated node // error or complete
* returnValue.errorsFound
** Type: array
* returnValue.graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifiers
},
fields: {
//...fields
}
},
userId: {
// if have userNode send to updated
},
versionDataSystemFields: {
versionedDataLabel: {
}
}
},
requestParams: {
// return example send param
},
parentFlowId:""
},
status: 'string',//"complete" // "error"
errorsFound: [],
graphServiceTag: 'string'
}
</syntaxhighlight>

== CreateRelationship ==
''' Use Case of CreateRelationship''' >>> https://izara.io/wiki/index.php/2025-08-01_-_Graph_Use_Case/CreateRelationship
=== Request Parameters ===
* firstObject
** Type: object
** Required: true
* secondObject
** Type: object
** Required: true
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* identifiers
** Type: object
** Required : true
* additionalRelationships
** Type: array of object
** Required: optional
* relType
** Type: object
** Required: true
* relationshipDirection
** Type: string
** Required: true
* relationshipProperties
** Type: object
** Required: true
* deepPathConditional
** Type : array
** Required: optional
** Description : using deepPathConditional for check relationship if not exist , can check on firstNode and seconNode or additionalRelationships
* Settings
** Type: object
** Required: true
* settings.updateRelPropsWhenExist
** Type: boolean
** Required: optional
* parentFlowId
** type : string
** Required: true
* callingFlow
** Type: string
** Required: optional
* callingFlowConfig
** Type: object
** Required: optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject": {
"objType": {
"serviceTag": string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"additionalRelationships": [
{
"objType": {
"serviceTag":string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"relType": {
"serviceTag":string,
"relationshipTag":string
},
"relationshipProperties": {
//…properties
},
"relationshipDirection":string ,// “from” , “to”
"deepPathConditional": []
}
]
},
"secondObject": {
"objType": {
"serviceTag":string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"additionalRelationships": [
//…optional
]
},
"relType": {
"serviceTag":string,
"relationshipTag":string
},
"relationshipDirection":string, // “from” , “to”
"relationshipProperties": {
//…properties
},
"deepPathConditional": [ // default []
{
condition: 'notExist',
conditionCheck: {
nodeStructure: {
objType: {

},
fields: { }
},
nextPath: {
relationshipStructure: {
relType: {

},
relationshipDirection: ''
},
nodeStructure: {
objType: {

},
fields: { }
}
}
}
}
]
"settings": {
"reateOnConditionalFail": false // true default = false
"updateRelPropsWhenExist": boolean,
},
"parentFlowId": "", // required
"callingFlow": "xxxx",
"callingFlowProperties": {
"graphServiceName": string
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.relationship
** Type: object
* queryResult.relationship.relType
** Type: object
* queryResult.relationship.relationshipProperties
** Type: object
* queryResult.firstNode
** Type: object
** Description: return data structure from firstNode
* queryResult.secondNode
** Type: object
** Description: return data structure from secondNode
* queryResult..onCreateAddRelationships
** Type: array
** Description: return data structure from onCreateAddRelationships
* returnValue.firstObject
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* Status
** Type: string
** Description: status from create node // error or complete
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
relationship: {
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//…properties
}
},
firstNode: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: { //… identifiers },
fields: {
//… all fields
}
},
onCreateAddRelationships: [
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//… identifiers
},
fields: {
//… all fields
}
},
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//… all properties
}
}
]
},
secondNode: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: { //… identifiers },
fields: {
//… all fields
}
},
onCreateAddRelationships: [
//… optional
]
}
}
}
}
requestParams: {
// return example send param

},
parentFlowId: "",
Status: 'string', //“complete” // “error”
errorsFound: []
}
}
</syntaxhighlight>

== GetRelationship ==
=== Request Parameters ===
* firstObject
** Type: object
** Required: optional
* secondObject
** Type: object
** Required: optional
* objType
** Type: object
** Required: true
** Description: has serviceTag and objectType
* identifiers
** Type: object
** Required: true
* relType
** Type: object
** Required: true
** Description: has relationshipTag and serviceTag
* relId
** Type: string
** Required: true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag":string,
"objectType":string
},
"identifiers":{
//…identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"relType":{ // required
"relationshipTag": string,
"serviceTag": string
},
"relId": 'string' // // required
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
* Type: object
* queryResult.relType
** Type: object
* queryResult.relationshipProperties
** Type: object
** Description: return relId and properties
* returnValue.toObject
** Type: object
** Description: return toObject if not send secondObject from param
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* errorsFound
** Type: array
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: {
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//…properties : 'string’
}
},
toObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: {
identifiers: {
//
},
fields: { }
}
},
requestParams: {
// return example send param
}
}
}

</syntaxhighlight>

== UpdateRelationship ==
=== Request Parameters ===
* firstObject
** Type: object
** Required: optional
* secondObject
** Type: object
** Required: Optional
* objType
** Type: object
** Required: true
** Description: has serviceTag and objectType
* identifiers
** Type: object
** Required: true
* relId
** Type: string
** Required: true
* relType
** Type: object
** Required: true
** Description: has relationshipTag and serviceTag
* relationshipProperties
** Type: object
** Required: true
** Description: send properties that want to update
* relationshipDirection
** Type: string
** Required: optional
* parentFlowId
** Type : string
** Required : true
* callingFlow
** Type: string
** Required: optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"relId": string,
"relType":{
"serviceTag":string,
"relationshipTag":string
},
"relationshipProperties":{
//… properties that want to update
},
"relationshipDirection": string, // "from" // “to”
"parentFlowId": ""// required
"callingFlow": string
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.firstObject And secondObject
** Type: object
** Description : return objType {seviceTag and objectType} And identifiers
* queryResult.relId
** Type: string
* queryResult.relType
** Type: object
** Description: return {seviceTag and relationshipTag}
* queryResult.relationshipDirection
** Type: string
* queryResult.updatePropertiesParam
** Type: object
** Description: return properties to updated
* queryResult.oldRelationshipProperties
** Type: object
** Description: return old properties before update
* queryResult.newRelationshipProperties
** Type: object
** Description: return new properties after updated
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type : string
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
firstObject: {
objType: {
serviceTag: "string",
objectType: "string"
},
identifiers: {
//…identifiers
}
},
secondObject: {
objType: {
serviceTag: "string",
objectType: "string"
},
identifiers: {
//…identifiers
}
},
relId: "string",
relType: {
serviceTag: "string",
relationshipTag: "string"
},
relationshipDirection: "string",
updatePropertiesParam: {
//… properties updated
},
oldRelationshipProperties: {
// … old properties before update
},
newRelationshipProperties: {
//… new properties after updated
}
}
},
requestParams: {
// return example send param
},
parentFlowId:"",
status: “string”, // "complete",”error”
errorsFound: []
}
</syntaxhighlight>

== GetNodeAndRelationship ==
=== Request Parameters ===
* sourceObjType
** Required: true
** Description: has serviceTag and objectType
* sourceIdentifiers
** Type: object
** Required: true
* sourceVersionedDataLabels
** Type: object
** Required: optional
* targetRelationships
** Type: Array
** Required: true
* relTypeAndDirection
** Type: object
** Required: true
* relTypeAndDirection.relType
** Type: object
** Required: true
** Description: has serviceTag and relationshipTag
* relTypeAndDirection.relationshipProperties
** Type: object
** Required: optional
* relTypeAndDirection.relationshipDirection
** Type: String
** Required: optional
* targetObjects
** Type: Array
** Required: Optional
* targetObjects.objType
** Type: object
** Required: required if send targetObjects in param
* targetObjects.identifiers
** Type: object
** Required: optional should have objType if identifiers exists
* targetObjects.versionedDataLabels
** Type: object
** Required: optional have objType if versionedDataLabels exists

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"sourceObjType": { // required
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"sourceIdentifiers": {}, // required
"sourceVersionedDataLabels": [], // optional
"targetRelationships": [ //required
{
"relTypeAndDirection": { // required
"relType": {
"serviceTag": "xxxx",
"relationshipTag": "rel"
},
"relationshipProperties": {},//optional
"relationshipDirection": "" // required
},
"targetObjects": [ // optional
{
"objType": {
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"identifiers": {}, // optional
"versionedDataLabels": [] // optional have objType if versionedDataLabels exists
}
]
},
// if have multiple relTypeAndDirection
],
"settings": {} // defaulf = false >>> if have versionedDataLabels want to return all field of versionedata: settings = { returnSystemFieldsName: true }
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.objTypes
** Type: array of object
** Description: return {serviceTag and objectType}
* queryResult.objInstanceFull
** Type: object
** Description: return {identifiers and fields}
* queryResult.relNodes:
** Type: array
* relNodes.relType
** Type: object
** Description: return {serviceTag and relationshipTag}
* relNodes.relationshipProperties
** Type: object
* relNodes.objTypes
** Type: array of object
** Description: return {serviceTag and objectType}
* relNodes.objInstanceFull
** Type: object
** Description: return {identifiers and fields}
* requestParams
** Type: object
** Description: return same requestParams
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: {},
fields: { }
},
relNodes: [
{
relType: {
serviceTag: 'xxxx',
relationshipTag: 'rel'
},
relationshipProperties: { },
objTypes: [
{
serviceTag: 'xxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: {},
fields: {
// field
}
},
versionDataSystemFields: {
'0VersionDataLabel': {
originTimestamp:
forMatchedId:
versionedDataId:
}
}
}
]
}
},
requestParam : {
// return example send param
},
errorsFound: [],
graphServiceTag: "GraphHandler"
}

</syntaxhighlight>

== ChangeRelationshipType ==
=== Request Parameters ===
* firstObject
** Type : object
** Required : true
* secondObject
** Type : object
** Required : true
* objType
** Type : object
** Required : true
* Identifiers
** Type : object
** Required : true
* oldRelTypeAndDirection
** Type : object
** Required : true
* oldRelTypeAndDirection.relType
** Type : object
** Required : true
* oldRelTypeAndDirection.relationshipDirection
** Type : string
** Required : true
* oldRelTypeAndDirection.relationshipProperties
** Type : object
** Required : optional
* newRelType
** Type : object
** Required : true
* originTimestamp
** Type : number
** Required : true
* changedByUserId
** Type : String
** Required : true
* settings
** Type : object
** Required : optional
** Description : default > settings.changeMultipleRelationships : false // if send settings.changeMultipleRelationships : true >> can change multiple relType
* parentFlowId
** Type: string
** required: true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"secondObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"oldRelTypeAndDirection":{
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"old"
},
"relationshipDirection":"from",
"relationshipProperties":{
//Properties
}
},
"newRelType":{
"serviceTag":"xxxx",
"relationshipTag":"new"
},
"originTimestamp":1234567890,
"changedByUserId":"xxxx",
"settings":{
"changeMultipleRelationships": boolean: // default false
},
parentFlowId: "" // required
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.newRelationshipType
** Type: object
* newRelationshipType.relType
** Type: object
* newRelationshipType.relationshipDirection
** Type: string
* newRelationshipType.relationshipProperties
** Type: object
* queryResult.oldRelationshipType
** Type: object
* oldRelationshipType.relType
** Type: object
* oldRelationshipType.relationshipDirection
** Type: string
* oldRelationshipType.relationshipProperties
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
newRelationshipType: {
relType: {
serviceTag: "xxxx",
relationshipTag: "new"
},
relationshipDirection: "" // 'from' or 'to'
relationshipProperties: {}
},
oldRelationshipType: {
relType: {
serviceTag: "xxxx",
relationshipTag: "old"
},
relationshipDirection: "" // 'from' or 'to'
relationshipProperties: {}
}
},
requestParams : {
// return example send param
}
},
status: "complete" // or error,
errorsFound: [],
graphServiceTag : 'GraphHandeler'
}

</syntaxhighlight>

== DeleteRelationship ==
=== Request Parameters ===
* fromObject
** Type : object
** Required : optional
* secondObject
** Type : object
** Required : optional
* objType
** Type : object
** Required : true
* Identifiers
** Type : object
** Required : true
* relType
** Type : object
** Required : true
* relId
** Type: string
** Required : true
* relationshipDirection
** Type: string
** Required : optional
* parentFlowId
** Type: string
** Requird: true
* callingFlow
** Type: string
** Required : true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"yyyy"
},
"relId":"string"
},
"relationshipDirection":"string"// "from" or "to"
"parentFlowIf": "", // required
"callingFlow":"string"
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.objects
** Type: array
* queryResult.objTypes
** Type: array
* queryResult.objInstanceFull.identifiers
** Type: object
* queryResult.objInstanceFull.fields
** Type: object
** Description: return data of fromObject and secondObject
* queryResult.userNode
** Type: object
** Description: return data of userNode
* queryResult.resultDeleteRel
** Type : string
** Description: return status Relationship Delete
* requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objects: [
{
objTypes: [
{
serviceTag: "xxxx",
objectType: "yyyy"
}
],
objInstanceFull: {
identifiers: {
// identifiers
},
fields: {
// fields
}
}
},
{
// if have multiple object objTypes
}
],
userNode: {
objTypes: [
{
serviceTag: "UserAccount",
objectType: "user"
}
],
objInstanceFull: {
identifiers: {
userId: "zzz"
}
}
},
resultDeleteRel: "Relationship Deleted" // default
},
requeatParam: {
// return example send param
},
status: "string", //default "complete" or "error"
errorsFound: []
}
}

</syntaxhighlight>

== DeleteNode ==
=== Request Parameters ===
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* identifiers
** Type : object
** Required: true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":"xxx",
"objectType":"yyy"
},
"identifiers":{
//
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResults
** Type: object
* queryResults.resultDeleteNode
** Type: Boolean
** Description: return status deleted node >> true or false
* requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
** Description: return status deleted node >> complete or error
* errorsFound
** Type: array
* graphServiceTag
** Type: string
=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: { resultDeleteNode: true }, // true or false
requestParams: {
// return example send param
}
},
status: 'string', // 'complete' or 'error'
errorsFound: [],
graphServiceTag: 'GraphHandler'
}
</syntaxhighlight>

== MoveRelationship ==

=== Request Parameters ===
* sourceObject
** Type : object
** Required : true
** Description: required objType: {serviceTag , objectType} and identifiers
* targetObjType
** Type : object
** Required : true
** Description: required objType: {serviceTag , objectType}
* relType
** Type : object
** Required : true
** Description: required objType: {serviceTag , relationshipTag}
* relationshipDirection
** Type : object
** Required : true
* moveToIdentifiers
** Type : object
** Required : true
* moveByUserId
** Type : String
** Required : true
* originTimestamp
** Type : number
** Required : true
* settings
** Type : object
** Required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"sourceObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyy"
},
"identifiers":{
// identifiers
}
},
"targetObjType":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
}
},
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"rel"
},
"relationshipDirection":"from", // "to"
"moveToIdentifiers":{
// target identifiers
},
"moveByUserId":"xxxx",
"originTimestamp":1234567890,
"settings":{}
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.moveRelationship
** Type: object
* moveRelationship.sourceObject
** Type: object
** Description: return data of sourceObject
* moveRelationship.relationship
** Type: string
** Description: return data of after move relationship
* moveRelationship.moveToObject
** Type: object
** Description: return data of moveToObject
* moveRelationship.historyData
** Type: object
** Description: return properties {old target identifiers and originTimestamp} after moveRelationship
* moveRelationship.userNode
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
moveRelationship: {
sourceObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
}
},
relationship: {
relType: {
serviceTag: 'xxxx',
relationshipTag: 'rel'
},
relationshipProperties: { originTimestamp: 1234567890 }
},
moveToObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: { }
},
historyData: {
relationshipProperties: { }
},
userNode: {
objTypes: [{ serviceTag: 'UserAccount', objectType: 'user' }],
objInstanceFull: { }
}
}
},
requestParam: {
}
}
status: "complete" // or error,
errorsFound: [],
graphServiceTag: 'GraphHandler'
}

</syntaxhighlight>

== MoveNodeProperties ==
=== Request Parameters ===
* sourceObject
** type: object
** required : true
* targetIdentifiers
** type : object
** required : true
* moveProperties
** type : array
** required : true // index minimum = 1
* updateProperties
** type : object
** required : true
* movePropertiesConditions
** type : array
** required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
sourceObject: {
objType: { },
identifier: { }
},
targetIdentifiers: { },
moveProperties: [ ],
updateProperties: { },
movePropertiesConditions: [ // optional
{
checkObject: 'target', // "source" | "target"
onSetObject: 'target', // "source" | "target"
onPassValue: true,
onNotPassCondition: false, // optional
fieldNameConditions: [ ]
}
]
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.moveNodeProperties
** Type: object
* moveNodeProperties.sourceObject
** Type: object
** Description: return data of sourceObject
* moveRelationship.moveFieldToObject
** Type: string
** Description: return data after moveFieldToObject
* moveRelationship.movedFields
** Type: object
** Description: return data field of moveToObject
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String
=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
moveNodeProperties: {
sourceObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: {
identifiers: { },
fields: { }
}
},
moveFieldToObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: { },
fields: {

}
},
movedFields: { Fields: { } } //
}
}
},
requestParam: { },
status: 'complete',
errorsFound: [],
graphServiceTag: 'GraphHandler'
}
</syntaxhighlight>
[[Category:Working documents| 2025-03-06]]

2025-03-06 - Graph Handler Docs

2026-06-11T07:31:07Z

Seagame: /* ChangeRelationshipType */

= GraphHandler Function =
== CreateNode ==
'''Use Case of CreateNode''' >>> https://izara.io/wiki/index.php/2025-03-27_Graph_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
* setFieldConditionals
** type : array
** Required : optional
* deepPathConditional
** type : array
** Required : optional
* parentFlowId
** type : string
** Required: true
* callingFlowConfig
** Type: object
** Required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType": {
"objectType": string,
"serviceTag": string
},
"objInstanceFull": {
"identifiers": {
// ...identifier
},
"fields": {
// ...fields
}
},
setFieldConditionals: [ // optional default array
{
objType: { },
indexValue: { nameSpace: 'ex-011', systemTextTag: 'Gate-011' }, // index field : value
fieldName: '', // fieldName want to set
passValue: 'false', optional
notPassValue: 'true', //optional
conditionals: [ optional ] // condition check field
}
],
"relationships": [
{
"relType": {
"serviceTag": string,
"relationshipTag": string
},
"relationshipProperties": {
//... key and value of targetIdentifiers
},
"relationshipDirection": string, // "from" | "to"
"targetObjType": {
"serviceTag": string,
"objectType": string
},
"targetIdentifiers": {
//... targetIdentifiers
}
}
],
deepPathConditional: [ // optional default array
{
condition: 'notExist', //
conditionCheck: { // traversal
nodeStructure: {
objType: { },
fields: { }
},
nextPath: {
relationshipStructure: {
relType: { },
relationshipDirection: 'to'
},
nodeStructure: {
objType: { },
fields: { }
}
}
}
}
],
"originTimestamp": number, // timestamp when create
"settings": {
"updatePropertiesOnMatch": boolean // default=false
},
"parentFlowId": "", // required
"callingFlow": string,
"callingFlowProperties": object,
}
</syntaxhighlight>

=== 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.relationships
** Type: array
** Description: data from relationships in targetNode
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* Status
** Type: string
** Description: Status from create node. Return "error" or "complete".
* errorsFound
** Type: array
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">

{
returnValue: {
queryResult: {
returnCreateNode: {
objTypes: [
{
serviceTag: "string",
objectType: "string"
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//...fields
}
},
existsNode: { },
userNode: { // // if has userNode send to createNode
objTypes: [
{
"serviceTag": "UserAccount",
"objectType": "user"
}
],
properties: {
//...properties
}
},
relationships: [ // optional : if has requiredOnCreated , createNode with targetNode
{
objTypes: [
{ serviceTag: 'string', objectType: 'string' }
],
objInstanceFull: {
identifiers: {
// identifiers
}
},
relType: {
serviceTag: 'string',
relationshipTag: 'rel'
},
relationshipProperties: {
// properties
}
},
]
}
},
requestParams: {
// return example send param
},
parentFlowId:""
},
status: "string", // "complete' or "error"
errorsFound: [],
graphServiceTag: "GraphHandler"
}

</syntaxhighlight>

== GetNode ==
'''Use Case of GetNode''' >>> https://izara.io/wiki/index.php/2025-04-23_Graph_Use_Case/GetNode_and_GetNodes#Use_Case_GetNodes
=== 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
* versionedDataLabels
** Type: Array
** Required : optional
* settings.updatePropertiesOnMatch
** Type: Boolean
** Required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":string,
"objectType":string
},
"objInstanceFull":{
"identifiers":{
// ...identifier
},
"fields":{
// ...fields
}
},
"versionedDataLabels":[
//…versionedData
],
"settings": {
"returnSystemFieldsName" :boolean // default = true or false
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* returnValue.queryResult
** Type: object
* queryResult.refactoredNodes
** Type: object
** Description: return object from getNode
* refactoredNodes.objTypes
** Type: array
* refactoredNodes.objInstanceFull
** Type: object
* refactoredNodes.objInstanceFull.identifiers
** Type: object
* refactoredNodes.objInstanceFull.fields
** Type: object
* refactoredNodes.versionDataSystemFields
** Type: object
* refactoredNodes.versionDataSystemFields.versionedDataLabel
** Type: object
* queryResult.requestParam
** Type: object
** Description: return example send param
* errorsFound
** Type: string
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
refactoredNodes: {
objTypes: [
{
serviceTag: "string",
objectType: "string",
}
],
objInstanceFull: {
identifiers: {
//… identifier
},
fields: {
//…fields
}
},
versionDataSystemFields: {
versionedDataLabel: {
originTimestamp: number,
forMatchedId: "string",
versionedDataId: "string"
}
}
}
},
requestParam: {
// return example send param
}
},
errorsFound: [],
graphServiceTag: ''
}
</syntaxhighlight>

== GetNodes ==
'''Use Case of GetNodes''' >>> https://izara.io/wiki/index.php/2025-04-23_Graph_Use_Case/GetNode_and_GetNodes#Use_Case_GetNodes
=== Request Parameters ===
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* fields
** Type : object
** Required: true
* versionedDataLabels
** Type: Array
** Required : optional
* settings.returnSystemFieldsName
** Type: Boolean
** Required : optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":string,
"objectType":string
},
"fields":{
//…fields with matching value
},
"versionedDataLabels":[
//…versionedDataLabels
],
"settings":{
"returnSystemFieldsName":boolean // default=false
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResults
** Type: object
* queryResults.getNodesReturnValues
** Type: array
* getNodesReturnValues.objTypes
** Type: array
* getNodesReturnValues.objInstanceFull
** Type: object
* getNodesReturnValues.objInstanceFull.identifiers
** Type: object
* getNodesReturnValues.objInstanceFull.fields
** Type: object
* getNodesReturnValues.versionDataSystemFields
** Type: object
* getNodesReturnValues.versionDataSystemFields.versionedDataLabel
** Type: object
* requestParams
** Type: object
* errorsFound
** Type: string
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: {
getNodesReturnValues: [
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//.. all fields-1
}
},
versionDataSystemFields: {}
},
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//...all fields-2
}
},
versionDataSystemFields: {
versionedDataLabel: {
originTimestamp: number,
forMatchedId: 'string',
versionedDataId: 'string'
}
}
}
]
},
requestParams: {
// return example send param
}
}
}
</syntaxhighlight>

== UpdateNode ==
''' Use Case of UpdateNode''' >>> https://izara.io/wiki/index.php/2025-08-03_-_Graph_Use_Case/UpdateNode
=== 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: object
** Required : true
* objInstanceFull.fields
** Type : object
** Required: true
** Description : can not send fields to update mainNode and versionedData together
* versionedDataIds
** Type: object
** Required: optional
* originTimestamp
** Type: number
** Required: true
* settings
** Type: object
** Required: optional
* parentFlowId
** type : string
** Required: true
* callingFlow
** Type: string
** Required: optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType": {
"serviceTag": string,
"objectType": string
},
"objInstanceFull": {
"identifiers": {
//…identifiers
},
"fields": {
//…fields
// can not be send fields of mainNode and versionedData in fields together!
}
},
"versionedDataIds": {},
"originTimestamp": number, //// timestamp when update
"settings": {},
"parentFlowId": ""// required
"callingFlow": string
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* returnValue.queryResult
** Type: object
** Description: data from created node
* queryResult.objTypes
** Type: array
** Description: serviceTag and objectType
* queryResult.objInstanceFull
** Type: object
** Description: identifiers and fields
* queryResult.userId
** Type: object
** Description: data that update from user Account
* queryResult.versionDataSystemFields
** Type: object
** Description: optional return versionedData
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* returnValue.Status
** Type: string
** Description: status from updated node // error or complete
* returnValue.errorsFound
** Type: array
* returnValue.graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifiers
},
fields: {
//...fields
}
},
userId: {
// if have userNode send to updated
},
versionDataSystemFields: {
versionedDataLabel: {
}
}
},
requestParams: {
// return example send param
},
parentFlowId:""
},
status: 'string',//"complete" // "error"
errorsFound: [],
graphServiceTag: 'string'
}
</syntaxhighlight>

== CreateRelationship ==
''' Use Case of CreateRelationship''' >>> https://izara.io/wiki/index.php/2025-08-01_-_Graph_Use_Case/CreateRelationship
=== Request Parameters ===
* firstObject
** Type: object
** Required: true
* secondObject
** Type: object
** Required: true
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* identifiers
** Type: object
** Required : true
* additionalRelationships
** Type: array of object
** Required: optional
* relType
** Type: object
** Required: true
* relationshipDirection
** Type: string
** Required: true
* relationshipProperties
** Type: object
** Required: true
* deepPathConditional
** Type : array
** Required: optional
** Description : using deepPathConditional for check relationship if not exist , can check on firstNode and seconNode or additionalRelationships
* Settings
** Type: object
** Required: true
* settings.updateRelPropsWhenExist
** Type: boolean
** Required: optional
* parentFlowId
** type : string
** Required: true
* callingFlow
** Type: string
** Required: optional
* callingFlowConfig
** Type: object
** Required: optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject": {
"objType": {
"serviceTag": string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"additionalRelationships": [
{
"objType": {
"serviceTag":string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"relType": {
"serviceTag":string,
"relationshipTag":string
},
"relationshipProperties": {
//…properties
},
"relationshipDirection":string ,// “from” , “to”
"deepPathConditional": []
}
]
},
"secondObject": {
"objType": {
"serviceTag":string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"additionalRelationships": [
//…optional
]
},
"relType": {
"serviceTag":string,
"relationshipTag":string
},
"relationshipDirection":string, // “from” , “to”
"relationshipProperties": {
//…properties
},
"deepPathConditional": [ // default []
{
condition: 'notExist',
conditionCheck: {
nodeStructure: {
objType: {

},
fields: { }
},
nextPath: {
relationshipStructure: {
relType: {

},
relationshipDirection: ''
},
nodeStructure: {
objType: {

},
fields: { }
}
}
}
}
]
"settings": {
"reateOnConditionalFail": false // true default = false
"updateRelPropsWhenExist": boolean,
},
"parentFlowId": "", // required
"callingFlow": "xxxx",
"callingFlowProperties": {
"graphServiceName": string
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.relationship
** Type: object
* queryResult.relationship.relType
** Type: object
* queryResult.relationship.relationshipProperties
** Type: object
* queryResult.firstNode
** Type: object
** Description: return data structure from firstNode
* queryResult.secondNode
** Type: object
** Description: return data structure from secondNode
* queryResult..onCreateAddRelationships
** Type: array
** Description: return data structure from onCreateAddRelationships
* returnValue.firstObject
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* Status
** Type: string
** Description: status from create node // error or complete
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
relationship: {
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//…properties
}
},
firstNode: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: { //… identifiers },
fields: {
//… all fields
}
},
onCreateAddRelationships: [
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//… identifiers
},
fields: {
//… all fields
}
},
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//… all properties
}
}
]
},
secondNode: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: { //… identifiers },
fields: {
//… all fields
}
},
onCreateAddRelationships: [
//… optional
]
}
}
}
}
requestParams: {
// return example send param

},
parentFlowId: "",
Status: 'string', //“complete” // “error”
errorsFound: []
}
}
</syntaxhighlight>

== GetRelationship ==
=== Request Parameters ===
* firstObject
** Type: object
** Required: optional
* secondObject
** Type: object
** Required: optional
* objType
** Type: object
** Required: true
** Description: has serviceTag and objectType
* identifiers
** Type: object
** Required: true
* relType
** Type: object
** Required: true
** Description: has relationshipTag and serviceTag
* relId
** Type: string
** Required: true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag":string,
"objectType":string
},
"identifiers":{
//…identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"relType":{ // required
"relationshipTag": string,
"serviceTag": string
},
"relId": 'string' // // required
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
* Type: object
* queryResult.relType
** Type: object
* queryResult.relationshipProperties
** Type: object
** Description: return relId and properties
* returnValue.toObject
** Type: object
** Description: return toObject if not send secondObject from param
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* errorsFound
** Type: array
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: {
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//…properties : 'string’
}
},
toObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: {
identifiers: {
//
},
fields: { }
}
},
requestParams: {
// return example send param
}
}
}

</syntaxhighlight>

== UpdateRelationship ==
=== Request Parameters ===
* firstObject
** Type: object
** Required: optional
* secondObject
** Type: object
** Required: Optional
* objType
** Type: object
** Required: true
** Description: has serviceTag and objectType
* identifiers
** Type: object
** Required: true
* relId
** Type: string
** Required: true
* relType
** Type: object
** Required: true
** Description: has relationshipTag and serviceTag
* relationshipProperties
** Type: object
** Required: true
** Description: send properties that want to update
* relationshipDirection
** Type: string
** Required: optional
* parentFlowId
** Type : string
** Required : true
* callingFlow
** Type: string
** Required: optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"relId": string,
"relType":{
"serviceTag":string,
"relationshipTag":string
},
"relationshipProperties":{
//… properties that want to update
},
"relationshipDirection": string, // "from" // “to”
"parentFlowId": ""// required
"callingFlow": string
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.firstObject And secondObject
** Type: object
** Description : return objType {seviceTag and objectType} And identifiers
* queryResult.relId
** Type: string
* queryResult.relType
** Type: object
** Description: return {seviceTag and relationshipTag}
* queryResult.relationshipDirection
** Type: string
* queryResult.updatePropertiesParam
** Type: object
** Description: return properties to updated
* queryResult.oldRelationshipProperties
** Type: object
** Description: return old properties before update
* queryResult.newRelationshipProperties
** Type: object
** Description: return new properties after updated
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type : string
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
firstObject: {
objType: {
serviceTag: "string",
objectType: "string"
},
identifiers: {
//…identifiers
}
},
secondObject: {
objType: {
serviceTag: "string",
objectType: "string"
},
identifiers: {
//…identifiers
}
},
relId: "string",
relType: {
serviceTag: "string",
relationshipTag: "string"
},
relationshipDirection: "string",
updatePropertiesParam: {
//… properties updated
},
oldRelationshipProperties: {
// … old properties before update
},
newRelationshipProperties: {
//… new properties after updated
}
}
},
requestParams: {
// return example send param
},
parentFlowId:"",
status: “string”, // "complete",”error”
errorsFound: []
}
</syntaxhighlight>

== GetNodeAndRelationship ==
=== Request Parameters ===
* sourceObjType
** Required: true
** Description: has serviceTag and objectType
* sourceIdentifiers
** Type: object
** Required: true
* sourceVersionedDataLabels
** Type: object
** Required: optional
* targetRelationships
** Type: Array
** Required: true
* relTypeAndDirection
** Type: object
** Required: true
* relTypeAndDirection.relType
** Type: object
** Required: true
** Description: has serviceTag and relationshipTag
* relTypeAndDirection.relationshipProperties
** Type: object
** Required: optional
* relTypeAndDirection.relationshipDirection
** Type: String
** Required: optional
* targetObjects
** Type: Array
** Required: Optional
* targetObjects.objType
** Type: object
** Required: required if send targetObjects in param
* targetObjects.identifiers
** Type: object
** Required: optional should have objType if identifiers exists
* targetObjects.versionedDataLabels
** Type: object
** Required: optional have objType if versionedDataLabels exists

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"sourceObjType": { // required
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"sourceIdentifiers": {}, // required
"sourceVersionedDataLabels": [], // optional
"targetRelationships": [ //required
{
"relTypeAndDirection": { // required
"relType": {
"serviceTag": "xxxx",
"relationshipTag": "rel"
},
"relationshipProperties": {},//optional
"relationshipDirection": "" // required
},
"targetObjects": [ // optional
{
"objType": {
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"identifiers": {}, // optional
"versionedDataLabels": [] // optional have objType if versionedDataLabels exists
}
]
},
// if have multiple relTypeAndDirection
],
"settings": {} // defaulf = false >>> if have versionedDataLabels want to return all field of versionedata: settings = { returnSystemFieldsName: true }
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.objTypes
** Type: array of object
** Description: return {serviceTag and objectType}
* queryResult.objInstanceFull
** Type: object
** Description: return {identifiers and fields}
* queryResult.relNodes:
** Type: array
* relNodes.relType
** Type: object
** Description: return {serviceTag and relationshipTag}
* relNodes.relationshipProperties
** Type: object
* relNodes.objTypes
** Type: array of object
** Description: return {serviceTag and objectType}
* relNodes.objInstanceFull
** Type: object
** Description: return {identifiers and fields}
* requestParams
** Type: object
** Description: return same requestParams
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: {},
fields: { }
},
relNodes: [
{
relType: {
serviceTag: 'xxxx',
relationshipTag: 'rel'
},
relationshipProperties: { },
objTypes: [
{
serviceTag: 'xxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: {},
fields: {
// field
}
},
versionDataSystemFields: {
'0VersionDataLabel': {
originTimestamp:
forMatchedId:
versionedDataId:
}
}
}
]
}
},
requestParam : {
// return example send param
},
errorsFound: [],
graphServiceTag: "GraphHandler"
}

</syntaxhighlight>

== ChangeRelationshipType ==
=== Request Parameters ===
* firstObject
** Type : object
** Required : true
* secondObject
** Type : object
** Required : true
* objType
** Type : object
** Required : true
* Identifiers
** Type : object
** Required : true
* oldRelTypeAndDirection
** Type : object
** Required : true
* oldRelTypeAndDirection.relType
** Type : object
** Required : true
* oldRelTypeAndDirection.relationshipDirection
** Type : string
** Required : true
* oldRelTypeAndDirection.relationshipProperties
** Type : object
** Required : optional
* newRelType
** Type : object
** Required : true
* originTimestamp
** Type : number
** Required : true
* changedByUserId
** Type : String
** Required : true
* settings
** Type : object
** Required : optional
** Description : default > settings.changeMultipleRelationships : false // if send settings.changeMultipleRelationships : true >> can change multiple relType
* parentFlowId
** Type: string
** required: true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"secondObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"oldRelTypeAndDirection":{
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"old"
},
"relationshipDirection":"from",
"relationshipProperties":{
//Properties
}
},
"newRelType":{
"serviceTag":"xxxx",
"relationshipTag":"new"
},
"originTimestamp":1234567890,
"changedByUserId":"xxxx",
"settings":{
"changeMultipleRelationships": boolean: // default false
},
parentFlowId: "" // required
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.newRelationshipType
** Type: object
* newRelationshipType.relType
** Type: object
* newRelationshipType.relationshipDirection
** Type: string
* newRelationshipType.relationshipProperties
** Type: object
* queryResult.oldRelationshipType
** Type: object
* oldRelationshipType.relType
** Type: object
* oldRelationshipType.relationshipDirection
** Type: string
* oldRelationshipType.relationshipProperties
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
newRelationshipType: {
relType: {
serviceTag: "xxxx",
relationshipTag: "new"
},
relationshipDirection: "" // 'from' or 'to'
relationshipProperties: {}
},
oldRelationshipType: {
relType: {
serviceTag: "xxxx",
relationshipTag: "old"
},
relationshipDirection: "" // 'from' or 'to'
relationshipProperties: {}
}
},
requestParams : {
// return example send param
}
},
status: "complete" // or error,
errorsFound: [],
graphServiceTag : 'GraphHandeler'
}

</syntaxhighlight>

== DeleteRelationship ==
=== Request Parameters ===
* fromObject
** Type : object
** Required : optional
* secondObject
** Type : object
** Required : optional
* objType
** Type : object
** Required : true
* Identifiers
** Type : object
** Required : true
* relType
** Type : object
** Required : true
* relId
** Type: string
** Required : true
* relationshipDirection
** Type: string
** Required : optional
* callingFlow
** Type: string
** Required : true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"yyyy"
},
"relId":"string"
},
"relationshipDirection":"string"// "from" or "to"
"callingFlow":"string"
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.objects
** Type: array
* queryResult.objTypes
** Type: array
* queryResult.objInstanceFull.identifiers
** Type: object
* queryResult.objInstanceFull.fields
** Type: object
** Description: return data of fromObject and secondObject
* queryResult.userNode
** Type: object
** Description: return data of userNode
* queryResult.resultDeleteRel
** Type : string
** Description: return status Relationship Delete
* requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objects: [
{
objTypes: [
{
serviceTag: "xxxx",
objectType: "yyyy"
}
],
objInstanceFull: {
identifiers: {
// identifiers
},
fields: {
// fields
}
}
},
{
// if have multiple object objTypes
}
],
userNode: {
objTypes: [
{
serviceTag: "UserAccount",
objectType: "user"
}
],
objInstanceFull: {
identifiers: {
userId: "zzz"
}
}
},
resultDeleteRel: "Relationship Deleted" // default
},
requeatParam: {
// return example send param
},
status: "string", //default "complete" or "error"
errorsFound: []
}
}

</syntaxhighlight>

== DeleteNode ==
=== Request Parameters ===
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* identifiers
** Type : object
** Required: true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":"xxx",
"objectType":"yyy"
},
"identifiers":{
//
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResults
** Type: object
* queryResults.resultDeleteNode
** Type: Boolean
** Description: return status deleted node >> true or false
* requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
** Description: return status deleted node >> complete or error
* errorsFound
** Type: array
* graphServiceTag
** Type: string
=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: { resultDeleteNode: true }, // true or false
requestParams: {
// return example send param
}
},
status: 'string', // 'complete' or 'error'
errorsFound: [],
graphServiceTag: 'GraphHandler'
}
</syntaxhighlight>

== MoveRelationship ==

=== Request Parameters ===
* sourceObject
** Type : object
** Required : true
** Description: required objType: {serviceTag , objectType} and identifiers
* targetObjType
** Type : object
** Required : true
** Description: required objType: {serviceTag , objectType}
* relType
** Type : object
** Required : true
** Description: required objType: {serviceTag , relationshipTag}
* relationshipDirection
** Type : object
** Required : true
* moveToIdentifiers
** Type : object
** Required : true
* moveByUserId
** Type : String
** Required : true
* originTimestamp
** Type : number
** Required : true
* settings
** Type : object
** Required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"sourceObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyy"
},
"identifiers":{
// identifiers
}
},
"targetObjType":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
}
},
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"rel"
},
"relationshipDirection":"from", // "to"
"moveToIdentifiers":{
// target identifiers
},
"moveByUserId":"xxxx",
"originTimestamp":1234567890,
"settings":{}
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.moveRelationship
** Type: object
* moveRelationship.sourceObject
** Type: object
** Description: return data of sourceObject
* moveRelationship.relationship
** Type: string
** Description: return data of after move relationship
* moveRelationship.moveToObject
** Type: object
** Description: return data of moveToObject
* moveRelationship.historyData
** Type: object
** Description: return properties {old target identifiers and originTimestamp} after moveRelationship
* moveRelationship.userNode
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
moveRelationship: {
sourceObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
}
},
relationship: {
relType: {
serviceTag: 'xxxx',
relationshipTag: 'rel'
},
relationshipProperties: { originTimestamp: 1234567890 }
},
moveToObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: { }
},
historyData: {
relationshipProperties: { }
},
userNode: {
objTypes: [{ serviceTag: 'UserAccount', objectType: 'user' }],
objInstanceFull: { }
}
}
},
requestParam: {
}
}
status: "complete" // or error,
errorsFound: [],
graphServiceTag: 'GraphHandler'
}

</syntaxhighlight>

== MoveNodeProperties ==
=== Request Parameters ===
* sourceObject
** type: object
** required : true
* targetIdentifiers
** type : object
** required : true
* moveProperties
** type : array
** required : true // index minimum = 1
* updateProperties
** type : object
** required : true
* movePropertiesConditions
** type : array
** required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
sourceObject: {
objType: { },
identifier: { }
},
targetIdentifiers: { },
moveProperties: [ ],
updateProperties: { },
movePropertiesConditions: [ // optional
{
checkObject: 'target', // "source" | "target"
onSetObject: 'target', // "source" | "target"
onPassValue: true,
onNotPassCondition: false, // optional
fieldNameConditions: [ ]
}
]
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.moveNodeProperties
** Type: object
* moveNodeProperties.sourceObject
** Type: object
** Description: return data of sourceObject
* moveRelationship.moveFieldToObject
** Type: string
** Description: return data after moveFieldToObject
* moveRelationship.movedFields
** Type: object
** Description: return data field of moveToObject
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String
=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
moveNodeProperties: {
sourceObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: {
identifiers: { },
fields: { }
}
},
moveFieldToObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: { },
fields: {

}
},
movedFields: { Fields: { } } //
}
}
},
requestParam: { },
status: 'complete',
errorsFound: [],
graphServiceTag: 'GraphHandler'
}
</syntaxhighlight>
[[Category:Working documents| 2025-03-06]]

2025-03-06 - Graph Handler Docs

2026-06-11T07:26:48Z

Seagame: /* Request Example */

= GraphHandler Function =
== CreateNode ==
'''Use Case of CreateNode''' >>> https://izara.io/wiki/index.php/2025-03-27_Graph_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
* setFieldConditionals
** type : array
** Required : optional
* deepPathConditional
** type : array
** Required : optional
* parentFlowId
** type : string
** Required: true
* callingFlowConfig
** Type: object
** Required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType": {
"objectType": string,
"serviceTag": string
},
"objInstanceFull": {
"identifiers": {
// ...identifier
},
"fields": {
// ...fields
}
},
setFieldConditionals: [ // optional default array
{
objType: { },
indexValue: { nameSpace: 'ex-011', systemTextTag: 'Gate-011' }, // index field : value
fieldName: '', // fieldName want to set
passValue: 'false', optional
notPassValue: 'true', //optional
conditionals: [ optional ] // condition check field
}
],
"relationships": [
{
"relType": {
"serviceTag": string,
"relationshipTag": string
},
"relationshipProperties": {
//... key and value of targetIdentifiers
},
"relationshipDirection": string, // "from" | "to"
"targetObjType": {
"serviceTag": string,
"objectType": string
},
"targetIdentifiers": {
//... targetIdentifiers
}
}
],
deepPathConditional: [ // optional default array
{
condition: 'notExist', //
conditionCheck: { // traversal
nodeStructure: {
objType: { },
fields: { }
},
nextPath: {
relationshipStructure: {
relType: { },
relationshipDirection: 'to'
},
nodeStructure: {
objType: { },
fields: { }
}
}
}
}
],
"originTimestamp": number, // timestamp when create
"settings": {
"updatePropertiesOnMatch": boolean // default=false
},
"parentFlowId": "", // required
"callingFlow": string,
"callingFlowProperties": object,
}
</syntaxhighlight>

=== 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.relationships
** Type: array
** Description: data from relationships in targetNode
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* Status
** Type: string
** Description: Status from create node. Return "error" or "complete".
* errorsFound
** Type: array
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">

{
returnValue: {
queryResult: {
returnCreateNode: {
objTypes: [
{
serviceTag: "string",
objectType: "string"
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//...fields
}
},
existsNode: { },
userNode: { // // if has userNode send to createNode
objTypes: [
{
"serviceTag": "UserAccount",
"objectType": "user"
}
],
properties: {
//...properties
}
},
relationships: [ // optional : if has requiredOnCreated , createNode with targetNode
{
objTypes: [
{ serviceTag: 'string', objectType: 'string' }
],
objInstanceFull: {
identifiers: {
// identifiers
}
},
relType: {
serviceTag: 'string',
relationshipTag: 'rel'
},
relationshipProperties: {
// properties
}
},
]
}
},
requestParams: {
// return example send param
},
parentFlowId:""
},
status: "string", // "complete' or "error"
errorsFound: [],
graphServiceTag: "GraphHandler"
}

</syntaxhighlight>

== GetNode ==
'''Use Case of GetNode''' >>> https://izara.io/wiki/index.php/2025-04-23_Graph_Use_Case/GetNode_and_GetNodes#Use_Case_GetNodes
=== 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
* versionedDataLabels
** Type: Array
** Required : optional
* settings.updatePropertiesOnMatch
** Type: Boolean
** Required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":string,
"objectType":string
},
"objInstanceFull":{
"identifiers":{
// ...identifier
},
"fields":{
// ...fields
}
},
"versionedDataLabels":[
//…versionedData
],
"settings": {
"returnSystemFieldsName" :boolean // default = true or false
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* returnValue.queryResult
** Type: object
* queryResult.refactoredNodes
** Type: object
** Description: return object from getNode
* refactoredNodes.objTypes
** Type: array
* refactoredNodes.objInstanceFull
** Type: object
* refactoredNodes.objInstanceFull.identifiers
** Type: object
* refactoredNodes.objInstanceFull.fields
** Type: object
* refactoredNodes.versionDataSystemFields
** Type: object
* refactoredNodes.versionDataSystemFields.versionedDataLabel
** Type: object
* queryResult.requestParam
** Type: object
** Description: return example send param
* errorsFound
** Type: string
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
refactoredNodes: {
objTypes: [
{
serviceTag: "string",
objectType: "string",
}
],
objInstanceFull: {
identifiers: {
//… identifier
},
fields: {
//…fields
}
},
versionDataSystemFields: {
versionedDataLabel: {
originTimestamp: number,
forMatchedId: "string",
versionedDataId: "string"
}
}
}
},
requestParam: {
// return example send param
}
},
errorsFound: [],
graphServiceTag: ''
}
</syntaxhighlight>

== GetNodes ==
'''Use Case of GetNodes''' >>> https://izara.io/wiki/index.php/2025-04-23_Graph_Use_Case/GetNode_and_GetNodes#Use_Case_GetNodes
=== Request Parameters ===
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* fields
** Type : object
** Required: true
* versionedDataLabels
** Type: Array
** Required : optional
* settings.returnSystemFieldsName
** Type: Boolean
** Required : optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":string,
"objectType":string
},
"fields":{
//…fields with matching value
},
"versionedDataLabels":[
//…versionedDataLabels
],
"settings":{
"returnSystemFieldsName":boolean // default=false
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResults
** Type: object
* queryResults.getNodesReturnValues
** Type: array
* getNodesReturnValues.objTypes
** Type: array
* getNodesReturnValues.objInstanceFull
** Type: object
* getNodesReturnValues.objInstanceFull.identifiers
** Type: object
* getNodesReturnValues.objInstanceFull.fields
** Type: object
* getNodesReturnValues.versionDataSystemFields
** Type: object
* getNodesReturnValues.versionDataSystemFields.versionedDataLabel
** Type: object
* requestParams
** Type: object
* errorsFound
** Type: string
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: {
getNodesReturnValues: [
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//.. all fields-1
}
},
versionDataSystemFields: {}
},
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//...all fields-2
}
},
versionDataSystemFields: {
versionedDataLabel: {
originTimestamp: number,
forMatchedId: 'string',
versionedDataId: 'string'
}
}
}
]
},
requestParams: {
// return example send param
}
}
}
</syntaxhighlight>

== UpdateNode ==
''' Use Case of UpdateNode''' >>> https://izara.io/wiki/index.php/2025-08-03_-_Graph_Use_Case/UpdateNode
=== 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: object
** Required : true
* objInstanceFull.fields
** Type : object
** Required: true
** Description : can not send fields to update mainNode and versionedData together
* versionedDataIds
** Type: object
** Required: optional
* originTimestamp
** Type: number
** Required: true
* settings
** Type: object
** Required: optional
* parentFlowId
** type : string
** Required: true
* callingFlow
** Type: string
** Required: optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType": {
"serviceTag": string,
"objectType": string
},
"objInstanceFull": {
"identifiers": {
//…identifiers
},
"fields": {
//…fields
// can not be send fields of mainNode and versionedData in fields together!
}
},
"versionedDataIds": {},
"originTimestamp": number, //// timestamp when update
"settings": {},
"parentFlowId": ""// required
"callingFlow": string
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* returnValue.queryResult
** Type: object
** Description: data from created node
* queryResult.objTypes
** Type: array
** Description: serviceTag and objectType
* queryResult.objInstanceFull
** Type: object
** Description: identifiers and fields
* queryResult.userId
** Type: object
** Description: data that update from user Account
* queryResult.versionDataSystemFields
** Type: object
** Description: optional return versionedData
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* returnValue.Status
** Type: string
** Description: status from updated node // error or complete
* returnValue.errorsFound
** Type: array
* returnValue.graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifiers
},
fields: {
//...fields
}
},
userId: {
// if have userNode send to updated
},
versionDataSystemFields: {
versionedDataLabel: {
}
}
},
requestParams: {
// return example send param
},
parentFlowId:""
},
status: 'string',//"complete" // "error"
errorsFound: [],
graphServiceTag: 'string'
}
</syntaxhighlight>

== CreateRelationship ==
''' Use Case of CreateRelationship''' >>> https://izara.io/wiki/index.php/2025-08-01_-_Graph_Use_Case/CreateRelationship
=== Request Parameters ===
* firstObject
** Type: object
** Required: true
* secondObject
** Type: object
** Required: true
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* identifiers
** Type: object
** Required : true
* additionalRelationships
** Type: array of object
** Required: optional
* relType
** Type: object
** Required: true
* relationshipDirection
** Type: string
** Required: true
* relationshipProperties
** Type: object
** Required: true
* deepPathConditional
** Type : array
** Required: optional
** Description : using deepPathConditional for check relationship if not exist , can check on firstNode and seconNode or additionalRelationships
* Settings
** Type: object
** Required: true
* settings.updateRelPropsWhenExist
** Type: boolean
** Required: optional
* parentFlowId
** type : string
** Required: true
* callingFlow
** Type: string
** Required: optional
* callingFlowConfig
** Type: object
** Required: optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject": {
"objType": {
"serviceTag": string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"additionalRelationships": [
{
"objType": {
"serviceTag":string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"relType": {
"serviceTag":string,
"relationshipTag":string
},
"relationshipProperties": {
//…properties
},
"relationshipDirection":string ,// “from” , “to”
"deepPathConditional": []
}
]
},
"secondObject": {
"objType": {
"serviceTag":string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"additionalRelationships": [
//…optional
]
},
"relType": {
"serviceTag":string,
"relationshipTag":string
},
"relationshipDirection":string, // “from” , “to”
"relationshipProperties": {
//…properties
},
"deepPathConditional": [ // default []
{
condition: 'notExist',
conditionCheck: {
nodeStructure: {
objType: {

},
fields: { }
},
nextPath: {
relationshipStructure: {
relType: {

},
relationshipDirection: ''
},
nodeStructure: {
objType: {

},
fields: { }
}
}
}
}
]
"settings": {
"reateOnConditionalFail": false // true default = false
"updateRelPropsWhenExist": boolean,
},
"parentFlowId": "", // required
"callingFlow": "xxxx",
"callingFlowProperties": {
"graphServiceName": string
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.relationship
** Type: object
* queryResult.relationship.relType
** Type: object
* queryResult.relationship.relationshipProperties
** Type: object
* queryResult.firstNode
** Type: object
** Description: return data structure from firstNode
* queryResult.secondNode
** Type: object
** Description: return data structure from secondNode
* queryResult..onCreateAddRelationships
** Type: array
** Description: return data structure from onCreateAddRelationships
* returnValue.firstObject
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* Status
** Type: string
** Description: status from create node // error or complete
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
relationship: {
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//…properties
}
},
firstNode: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: { //… identifiers },
fields: {
//… all fields
}
},
onCreateAddRelationships: [
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//… identifiers
},
fields: {
//… all fields
}
},
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//… all properties
}
}
]
},
secondNode: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: { //… identifiers },
fields: {
//… all fields
}
},
onCreateAddRelationships: [
//… optional
]
}
}
}
}
requestParams: {
// return example send param

},
parentFlowId: "",
Status: 'string', //“complete” // “error”
errorsFound: []
}
}
</syntaxhighlight>

== GetRelationship ==
=== Request Parameters ===
* firstObject
** Type: object
** Required: optional
* secondObject
** Type: object
** Required: optional
* objType
** Type: object
** Required: true
** Description: has serviceTag and objectType
* identifiers
** Type: object
** Required: true
* relType
** Type: object
** Required: true
** Description: has relationshipTag and serviceTag
* relId
** Type: string
** Required: true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag":string,
"objectType":string
},
"identifiers":{
//…identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"relType":{ // required
"relationshipTag": string,
"serviceTag": string
},
"relId": 'string' // // required
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
* Type: object
* queryResult.relType
** Type: object
* queryResult.relationshipProperties
** Type: object
** Description: return relId and properties
* returnValue.toObject
** Type: object
** Description: return toObject if not send secondObject from param
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* errorsFound
** Type: array
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: {
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//…properties : 'string’
}
},
toObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: {
identifiers: {
//
},
fields: { }
}
},
requestParams: {
// return example send param
}
}
}

</syntaxhighlight>

== UpdateRelationship ==
=== Request Parameters ===
* firstObject
** Type: object
** Required: optional
* secondObject
** Type: object
** Required: Optional
* objType
** Type: object
** Required: true
** Description: has serviceTag and objectType
* identifiers
** Type: object
** Required: true
* relId
** Type: string
** Required: true
* relType
** Type: object
** Required: true
** Description: has relationshipTag and serviceTag
* relationshipProperties
** Type: object
** Required: true
** Description: send properties that want to update
* relationshipDirection
** Type: string
** Required: optional
* parentFlowId
** Type : string
** Required : true
* callingFlow
** Type: string
** Required: optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"relId": string,
"relType":{
"serviceTag":string,
"relationshipTag":string
},
"relationshipProperties":{
//… properties that want to update
},
"relationshipDirection": string, // "from" // “to”
"parentFlowId": ""// required
"callingFlow": string
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.firstObject And secondObject
** Type: object
** Description : return objType {seviceTag and objectType} And identifiers
* queryResult.relId
** Type: string
* queryResult.relType
** Type: object
** Description: return {seviceTag and relationshipTag}
* queryResult.relationshipDirection
** Type: string
* queryResult.updatePropertiesParam
** Type: object
** Description: return properties to updated
* queryResult.oldRelationshipProperties
** Type: object
** Description: return old properties before update
* queryResult.newRelationshipProperties
** Type: object
** Description: return new properties after updated
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type : string
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
firstObject: {
objType: {
serviceTag: "string",
objectType: "string"
},
identifiers: {
//…identifiers
}
},
secondObject: {
objType: {
serviceTag: "string",
objectType: "string"
},
identifiers: {
//…identifiers
}
},
relId: "string",
relType: {
serviceTag: "string",
relationshipTag: "string"
},
relationshipDirection: "string",
updatePropertiesParam: {
//… properties updated
},
oldRelationshipProperties: {
// … old properties before update
},
newRelationshipProperties: {
//… new properties after updated
}
}
},
requestParams: {
// return example send param
},
parentFlowId:"",
status: “string”, // "complete",”error”
errorsFound: []
}
</syntaxhighlight>

== GetNodeAndRelationship ==
=== Request Parameters ===
* sourceObjType
** Required: true
** Description: has serviceTag and objectType
* sourceIdentifiers
** Type: object
** Required: true
* sourceVersionedDataLabels
** Type: object
** Required: optional
* targetRelationships
** Type: Array
** Required: true
* relTypeAndDirection
** Type: object
** Required: true
* relTypeAndDirection.relType
** Type: object
** Required: true
** Description: has serviceTag and relationshipTag
* relTypeAndDirection.relationshipProperties
** Type: object
** Required: optional
* relTypeAndDirection.relationshipDirection
** Type: String
** Required: optional
* targetObjects
** Type: Array
** Required: Optional
* targetObjects.objType
** Type: object
** Required: required if send targetObjects in param
* targetObjects.identifiers
** Type: object
** Required: optional should have objType if identifiers exists
* targetObjects.versionedDataLabels
** Type: object
** Required: optional have objType if versionedDataLabels exists

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"sourceObjType": { // required
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"sourceIdentifiers": {}, // required
"sourceVersionedDataLabels": [], // optional
"targetRelationships": [ //required
{
"relTypeAndDirection": { // required
"relType": {
"serviceTag": "xxxx",
"relationshipTag": "rel"
},
"relationshipProperties": {},//optional
"relationshipDirection": "" // required
},
"targetObjects": [ // optional
{
"objType": {
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"identifiers": {}, // optional
"versionedDataLabels": [] // optional have objType if versionedDataLabels exists
}
]
},
// if have multiple relTypeAndDirection
],
"settings": {} // defaulf = false >>> if have versionedDataLabels want to return all field of versionedata: settings = { returnSystemFieldsName: true }
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.objTypes
** Type: array of object
** Description: return {serviceTag and objectType}
* queryResult.objInstanceFull
** Type: object
** Description: return {identifiers and fields}
* queryResult.relNodes:
** Type: array
* relNodes.relType
** Type: object
** Description: return {serviceTag and relationshipTag}
* relNodes.relationshipProperties
** Type: object
* relNodes.objTypes
** Type: array of object
** Description: return {serviceTag and objectType}
* relNodes.objInstanceFull
** Type: object
** Description: return {identifiers and fields}
* requestParams
** Type: object
** Description: return same requestParams
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: {},
fields: { }
},
relNodes: [
{
relType: {
serviceTag: 'xxxx',
relationshipTag: 'rel'
},
relationshipProperties: { },
objTypes: [
{
serviceTag: 'xxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: {},
fields: {
// field
}
},
versionDataSystemFields: {
'0VersionDataLabel': {
originTimestamp:
forMatchedId:
versionedDataId:
}
}
}
]
}
},
requestParam : {
// return example send param
},
errorsFound: [],
graphServiceTag: "GraphHandler"
}

</syntaxhighlight>

== ChangeRelationshipType ==
=== Request Parameters ===
* firstObject
** Type : object
** Required : true
* secondObject
** Type : object
** Required : true
* objType
** Type : object
** Required : true
* Identifiers
** Type : object
** Required : true
* oldRelTypeAndDirection
** Type : object
** Required : true
* oldRelTypeAndDirection.relType
** Type : object
** Required : true
* oldRelTypeAndDirection.relationshipDirection
** Type : string
** Required : true
* oldRelTypeAndDirection.relationshipProperties
** Type : object
** Required : optional
* newRelType
** Type : object
** Required : true
* originTimestamp
** Type : number
** Required : true
* changedByUserId
** Type : String
** Required : true
* callingFlow
** Type : String
** Required : optional
* settings
** Type : object
** Required : optional
** Description : default > settings.changeMultipleRelationships : false // if send settings.changeMultipleRelationships : true >> can change multiple relType

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"secondObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"oldRelTypeAndDirection":{
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"old"
},
"relationshipDirection":"from",
"relationshipProperties":{
//Properties
}
},
"newRelType":{
"serviceTag":"xxxx",
"relationshipTag":"new"
},
"originTimestamp":1234567890,
"changedByUserId":"xxxx",
"callingFlow":"yyyy",
"settings":{
"changeMultipleRelationships": boolean: // default false
}
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.newRelationshipType
** Type: object
* newRelationshipType.relType
** Type: object
* newRelationshipType.relationshipDirection
** Type: string
* newRelationshipType.relationshipProperties
** Type: object
* queryResult.oldRelationshipType
** Type: object
* oldRelationshipType.relType
** Type: object
* oldRelationshipType.relationshipDirection
** Type: string
* oldRelationshipType.relationshipProperties
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
newRelationshipType: {
relType: {
serviceTag: "xxxx",
relationshipTag: "new"
},
relationshipDirection: "" // 'from' or 'to'
relationshipProperties: {}
},
oldRelationshipType: {
relType: {
serviceTag: "xxxx",
relationshipTag: "old"
},
relationshipDirection: "" // 'from' or 'to'
relationshipProperties: {}
}
},
requestParams : {
// return example send param
}
},
status: "complete" // or error,
errorsFound: [],
graphServiceTag : 'GraphHandeler'
}

</syntaxhighlight>

== DeleteRelationship ==
=== Request Parameters ===
* fromObject
** Type : object
** Required : optional
* secondObject
** Type : object
** Required : optional
* objType
** Type : object
** Required : true
* Identifiers
** Type : object
** Required : true
* relType
** Type : object
** Required : true
* relId
** Type: string
** Required : true
* relationshipDirection
** Type: string
** Required : optional
* callingFlow
** Type: string
** Required : true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"yyyy"
},
"relId":"string"
},
"relationshipDirection":"string"// "from" or "to"
"callingFlow":"string"
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.objects
** Type: array
* queryResult.objTypes
** Type: array
* queryResult.objInstanceFull.identifiers
** Type: object
* queryResult.objInstanceFull.fields
** Type: object
** Description: return data of fromObject and secondObject
* queryResult.userNode
** Type: object
** Description: return data of userNode
* queryResult.resultDeleteRel
** Type : string
** Description: return status Relationship Delete
* requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objects: [
{
objTypes: [
{
serviceTag: "xxxx",
objectType: "yyyy"
}
],
objInstanceFull: {
identifiers: {
// identifiers
},
fields: {
// fields
}
}
},
{
// if have multiple object objTypes
}
],
userNode: {
objTypes: [
{
serviceTag: "UserAccount",
objectType: "user"
}
],
objInstanceFull: {
identifiers: {
userId: "zzz"
}
}
},
resultDeleteRel: "Relationship Deleted" // default
},
requeatParam: {
// return example send param
},
status: "string", //default "complete" or "error"
errorsFound: []
}
}

</syntaxhighlight>

== DeleteNode ==
=== Request Parameters ===
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* identifiers
** Type : object
** Required: true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":"xxx",
"objectType":"yyy"
},
"identifiers":{
//
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResults
** Type: object
* queryResults.resultDeleteNode
** Type: Boolean
** Description: return status deleted node >> true or false
* requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
** Description: return status deleted node >> complete or error
* errorsFound
** Type: array
* graphServiceTag
** Type: string
=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: { resultDeleteNode: true }, // true or false
requestParams: {
// return example send param
}
},
status: 'string', // 'complete' or 'error'
errorsFound: [],
graphServiceTag: 'GraphHandler'
}
</syntaxhighlight>

== MoveRelationship ==

=== Request Parameters ===
* sourceObject
** Type : object
** Required : true
** Description: required objType: {serviceTag , objectType} and identifiers
* targetObjType
** Type : object
** Required : true
** Description: required objType: {serviceTag , objectType}
* relType
** Type : object
** Required : true
** Description: required objType: {serviceTag , relationshipTag}
* relationshipDirection
** Type : object
** Required : true
* moveToIdentifiers
** Type : object
** Required : true
* moveByUserId
** Type : String
** Required : true
* originTimestamp
** Type : number
** Required : true
* settings
** Type : object
** Required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"sourceObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyy"
},
"identifiers":{
// identifiers
}
},
"targetObjType":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
}
},
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"rel"
},
"relationshipDirection":"from", // "to"
"moveToIdentifiers":{
// target identifiers
},
"moveByUserId":"xxxx",
"originTimestamp":1234567890,
"settings":{}
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.moveRelationship
** Type: object
* moveRelationship.sourceObject
** Type: object
** Description: return data of sourceObject
* moveRelationship.relationship
** Type: string
** Description: return data of after move relationship
* moveRelationship.moveToObject
** Type: object
** Description: return data of moveToObject
* moveRelationship.historyData
** Type: object
** Description: return properties {old target identifiers and originTimestamp} after moveRelationship
* moveRelationship.userNode
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
moveRelationship: {
sourceObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
}
},
relationship: {
relType: {
serviceTag: 'xxxx',
relationshipTag: 'rel'
},
relationshipProperties: { originTimestamp: 1234567890 }
},
moveToObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: { }
},
historyData: {
relationshipProperties: { }
},
userNode: {
objTypes: [{ serviceTag: 'UserAccount', objectType: 'user' }],
objInstanceFull: { }
}
}
},
requestParam: {
}
}
status: "complete" // or error,
errorsFound: [],
graphServiceTag: 'GraphHandler'
}

</syntaxhighlight>

== MoveNodeProperties ==
=== Request Parameters ===
* sourceObject
** type: object
** required : true
* targetIdentifiers
** type : object
** required : true
* moveProperties
** type : array
** required : true // index minimum = 1
* updateProperties
** type : object
** required : true
* movePropertiesConditions
** type : array
** required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
sourceObject: {
objType: { },
identifier: { }
},
targetIdentifiers: { },
moveProperties: [ ],
updateProperties: { },
movePropertiesConditions: [ // optional
{
checkObject: 'target', // "source" | "target"
onSetObject: 'target', // "source" | "target"
onPassValue: true,
onNotPassCondition: false, // optional
fieldNameConditions: [ ]
}
]
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.moveNodeProperties
** Type: object
* moveNodeProperties.sourceObject
** Type: object
** Description: return data of sourceObject
* moveRelationship.moveFieldToObject
** Type: string
** Description: return data after moveFieldToObject
* moveRelationship.movedFields
** Type: object
** Description: return data field of moveToObject
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String
=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
moveNodeProperties: {
sourceObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: {
identifiers: { },
fields: { }
}
},
moveFieldToObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: { },
fields: {

}
},
movedFields: { Fields: { } } //
}
}
},
requestParam: { },
status: 'complete',
errorsFound: [],
graphServiceTag: 'GraphHandler'
}
</syntaxhighlight>
[[Category:Working documents| 2025-03-06]]

2025-03-06 - Graph Handler Docs

2026-06-11T07:25:47Z

Seagame: /* GetRelationship */

= GraphHandler Function =
== CreateNode ==
'''Use Case of CreateNode''' >>> https://izara.io/wiki/index.php/2025-03-27_Graph_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
* setFieldConditionals
** type : array
** Required : optional
* deepPathConditional
** type : array
** Required : optional
* parentFlowId
** type : string
** Required: true
* callingFlowConfig
** Type: object
** Required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType": {
"objectType": string,
"serviceTag": string
},
"objInstanceFull": {
"identifiers": {
// ...identifier
},
"fields": {
// ...fields
}
},
setFieldConditionals: [ // optional default array
{
objType: { },
indexValue: { nameSpace: 'ex-011', systemTextTag: 'Gate-011' }, // index field : value
fieldName: '', // fieldName want to set
passValue: 'false', optional
notPassValue: 'true', //optional
conditionals: [ optional ] // condition check field
}
],
"relationships": [
{
"relType": {
"serviceTag": string,
"relationshipTag": string
},
"relationshipProperties": {
//... key and value of targetIdentifiers
},
"relationshipDirection": string, // "from" | "to"
"targetObjType": {
"serviceTag": string,
"objectType": string
},
"targetIdentifiers": {
//... targetIdentifiers
}
}
],
deepPathConditional: [ // optional default array
{
condition: 'notExist', //
conditionCheck: { // traversal
nodeStructure: {
objType: { },
fields: { }
},
nextPath: {
relationshipStructure: {
relType: { },
relationshipDirection: 'to'
},
nodeStructure: {
objType: { },
fields: { }
}
}
}
}
],
"originTimestamp": number, // timestamp when create
"settings": {
"updatePropertiesOnMatch": boolean // default=false
},
"parentFlowId": "", // required
"callingFlow": string,
"callingFlowProperties": object,
}
</syntaxhighlight>

=== 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.relationships
** Type: array
** Description: data from relationships in targetNode
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* Status
** Type: string
** Description: Status from create node. Return "error" or "complete".
* errorsFound
** Type: array
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">

{
returnValue: {
queryResult: {
returnCreateNode: {
objTypes: [
{
serviceTag: "string",
objectType: "string"
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//...fields
}
},
existsNode: { },
userNode: { // // if has userNode send to createNode
objTypes: [
{
"serviceTag": "UserAccount",
"objectType": "user"
}
],
properties: {
//...properties
}
},
relationships: [ // optional : if has requiredOnCreated , createNode with targetNode
{
objTypes: [
{ serviceTag: 'string', objectType: 'string' }
],
objInstanceFull: {
identifiers: {
// identifiers
}
},
relType: {
serviceTag: 'string',
relationshipTag: 'rel'
},
relationshipProperties: {
// properties
}
},
]
}
},
requestParams: {
// return example send param
},
parentFlowId:""
},
status: "string", // "complete' or "error"
errorsFound: [],
graphServiceTag: "GraphHandler"
}

</syntaxhighlight>

== GetNode ==
'''Use Case of GetNode''' >>> https://izara.io/wiki/index.php/2025-04-23_Graph_Use_Case/GetNode_and_GetNodes#Use_Case_GetNodes
=== 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
* versionedDataLabels
** Type: Array
** Required : optional
* settings.updatePropertiesOnMatch
** Type: Boolean
** Required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":string,
"objectType":string
},
"objInstanceFull":{
"identifiers":{
// ...identifier
},
"fields":{
// ...fields
}
},
"versionedDataLabels":[
//…versionedData
],
"settings": {
"returnSystemFieldsName" :boolean // default = true or false
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* returnValue.queryResult
** Type: object
* queryResult.refactoredNodes
** Type: object
** Description: return object from getNode
* refactoredNodes.objTypes
** Type: array
* refactoredNodes.objInstanceFull
** Type: object
* refactoredNodes.objInstanceFull.identifiers
** Type: object
* refactoredNodes.objInstanceFull.fields
** Type: object
* refactoredNodes.versionDataSystemFields
** Type: object
* refactoredNodes.versionDataSystemFields.versionedDataLabel
** Type: object
* queryResult.requestParam
** Type: object
** Description: return example send param
* errorsFound
** Type: string
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
refactoredNodes: {
objTypes: [
{
serviceTag: "string",
objectType: "string",
}
],
objInstanceFull: {
identifiers: {
//… identifier
},
fields: {
//…fields
}
},
versionDataSystemFields: {
versionedDataLabel: {
originTimestamp: number,
forMatchedId: "string",
versionedDataId: "string"
}
}
}
},
requestParam: {
// return example send param
}
},
errorsFound: [],
graphServiceTag: ''
}
</syntaxhighlight>

== GetNodes ==
'''Use Case of GetNodes''' >>> https://izara.io/wiki/index.php/2025-04-23_Graph_Use_Case/GetNode_and_GetNodes#Use_Case_GetNodes
=== Request Parameters ===
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* fields
** Type : object
** Required: true
* versionedDataLabels
** Type: Array
** Required : optional
* settings.returnSystemFieldsName
** Type: Boolean
** Required : optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":string,
"objectType":string
},
"fields":{
//…fields with matching value
},
"versionedDataLabels":[
//…versionedDataLabels
],
"settings":{
"returnSystemFieldsName":boolean // default=false
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResults
** Type: object
* queryResults.getNodesReturnValues
** Type: array
* getNodesReturnValues.objTypes
** Type: array
* getNodesReturnValues.objInstanceFull
** Type: object
* getNodesReturnValues.objInstanceFull.identifiers
** Type: object
* getNodesReturnValues.objInstanceFull.fields
** Type: object
* getNodesReturnValues.versionDataSystemFields
** Type: object
* getNodesReturnValues.versionDataSystemFields.versionedDataLabel
** Type: object
* requestParams
** Type: object
* errorsFound
** Type: string
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: {
getNodesReturnValues: [
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//.. all fields-1
}
},
versionDataSystemFields: {}
},
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//...all fields-2
}
},
versionDataSystemFields: {
versionedDataLabel: {
originTimestamp: number,
forMatchedId: 'string',
versionedDataId: 'string'
}
}
}
]
},
requestParams: {
// return example send param
}
}
}
</syntaxhighlight>

== UpdateNode ==
''' Use Case of UpdateNode''' >>> https://izara.io/wiki/index.php/2025-08-03_-_Graph_Use_Case/UpdateNode
=== 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: object
** Required : true
* objInstanceFull.fields
** Type : object
** Required: true
** Description : can not send fields to update mainNode and versionedData together
* versionedDataIds
** Type: object
** Required: optional
* originTimestamp
** Type: number
** Required: true
* settings
** Type: object
** Required: optional
* parentFlowId
** type : string
** Required: true
* callingFlow
** Type: string
** Required: optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType": {
"serviceTag": string,
"objectType": string
},
"objInstanceFull": {
"identifiers": {
//…identifiers
},
"fields": {
//…fields
// can not be send fields of mainNode and versionedData in fields together!
}
},
"versionedDataIds": {},
"originTimestamp": number, //// timestamp when update
"settings": {},
"parentFlowId": ""// required
"callingFlow": string
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* returnValue.queryResult
** Type: object
** Description: data from created node
* queryResult.objTypes
** Type: array
** Description: serviceTag and objectType
* queryResult.objInstanceFull
** Type: object
** Description: identifiers and fields
* queryResult.userId
** Type: object
** Description: data that update from user Account
* queryResult.versionDataSystemFields
** Type: object
** Description: optional return versionedData
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* returnValue.Status
** Type: string
** Description: status from updated node // error or complete
* returnValue.errorsFound
** Type: array
* returnValue.graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifiers
},
fields: {
//...fields
}
},
userId: {
// if have userNode send to updated
},
versionDataSystemFields: {
versionedDataLabel: {
}
}
},
requestParams: {
// return example send param
},
parentFlowId:""
},
status: 'string',//"complete" // "error"
errorsFound: [],
graphServiceTag: 'string'
}
</syntaxhighlight>

== CreateRelationship ==
''' Use Case of CreateRelationship''' >>> https://izara.io/wiki/index.php/2025-08-01_-_Graph_Use_Case/CreateRelationship
=== Request Parameters ===
* firstObject
** Type: object
** Required: true
* secondObject
** Type: object
** Required: true
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* identifiers
** Type: object
** Required : true
* additionalRelationships
** Type: array of object
** Required: optional
* relType
** Type: object
** Required: true
* relationshipDirection
** Type: string
** Required: true
* relationshipProperties
** Type: object
** Required: true
* deepPathConditional
** Type : array
** Required: optional
** Description : using deepPathConditional for check relationship if not exist , can check on firstNode and seconNode or additionalRelationships
* Settings
** Type: object
** Required: true
* settings.updateRelPropsWhenExist
** Type: boolean
** Required: optional
* parentFlowId
** type : string
** Required: true
* callingFlow
** Type: string
** Required: optional
* callingFlowConfig
** Type: object
** Required: optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject": {
"objType": {
"serviceTag": string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"additionalRelationships": [
{
"objType": {
"serviceTag":string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"relType": {
"serviceTag":string,
"relationshipTag":string
},
"relationshipProperties": {
//…properties
},
"relationshipDirection":string ,// “from” , “to”
"deepPathConditional": []
}
]
},
"secondObject": {
"objType": {
"serviceTag":string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"additionalRelationships": [
//…optional
]
},
"relType": {
"serviceTag":string,
"relationshipTag":string
},
"relationshipDirection":string, // “from” , “to”
"relationshipProperties": {
//…properties
},
"deepPathConditional": [ // default []
{
condition: 'notExist',
conditionCheck: {
nodeStructure: {
objType: {

},
fields: { }
},
nextPath: {
relationshipStructure: {
relType: {

},
relationshipDirection: ''
},
nodeStructure: {
objType: {

},
fields: { }
}
}
}
}
]
"settings": {
"reateOnConditionalFail": false // true default = false
"updateRelPropsWhenExist": boolean,
},
"parentFlowId": "", // required
"callingFlow": "xxxx",
"callingFlowProperties": {
"graphServiceName": string
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.relationship
** Type: object
* queryResult.relationship.relType
** Type: object
* queryResult.relationship.relationshipProperties
** Type: object
* queryResult.firstNode
** Type: object
** Description: return data structure from firstNode
* queryResult.secondNode
** Type: object
** Description: return data structure from secondNode
* queryResult..onCreateAddRelationships
** Type: array
** Description: return data structure from onCreateAddRelationships
* returnValue.firstObject
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* Status
** Type: string
** Description: status from create node // error or complete
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
relationship: {
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//…properties
}
},
firstNode: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: { //… identifiers },
fields: {
//… all fields
}
},
onCreateAddRelationships: [
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//… identifiers
},
fields: {
//… all fields
}
},
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//… all properties
}
}
]
},
secondNode: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: { //… identifiers },
fields: {
//… all fields
}
},
onCreateAddRelationships: [
//… optional
]
}
}
}
}
requestParams: {
// return example send param

},
parentFlowId: "",
Status: 'string', //“complete” // “error”
errorsFound: []
}
}
</syntaxhighlight>

== GetRelationship ==
=== Request Parameters ===
* firstObject
** Type: object
** Required: optional
* secondObject
** Type: object
** Required: optional
* objType
** Type: object
** Required: true
** Description: has serviceTag and objectType
* identifiers
** Type: object
** Required: true
* relType
** Type: object
** Required: true
** Description: has relationshipTag and serviceTag
* relId
** Type: string
** Required: true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag":string,
"objectType":string
},
"identifiers":{
//…identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"relType":{ // required
"relationshipTag": string,
"serviceTag": string
},
"relId": 'string' // // required
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
* Type: object
* queryResult.relType
** Type: object
* queryResult.relationshipProperties
** Type: object
** Description: return relId and properties
* returnValue.toObject
** Type: object
** Description: return toObject if not send secondObject from param
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* errorsFound
** Type: array
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: {
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//…properties : 'string’
}
},
toObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: {
identifiers: {
//
},
fields: { }
}
},
requestParams: {
// return example send param
}
}
}

</syntaxhighlight>

== UpdateRelationship ==
=== Request Parameters ===
* firstObject
** Type: object
** Required: optional
* secondObject
** Type: object
** Required: Optional
* objType
** Type: object
** Required: true
** Description: has serviceTag and objectType
* identifiers
** Type: object
** Required: true
* relId
** Type: string
** Required: true
* relType
** Type: object
** Required: true
** Description: has relationshipTag and serviceTag
* relationshipProperties
** Type: object
** Required: true
** Description: send properties that want to update
* relationshipDirection
** Type: string
** Required: optional
* parentFlowId
** Type : string
** Required : true
* callingFlow
** Type: string
** Required: optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"relId": string,
"relType":{
"serviceTag":string,
"relationshipTag":string
},
"relationshipProperties":{
//… properties that want to update
},
"relationshipDirection": string, // "from" // “to”
"parentFlowId": ""// required
"callingFlow": string
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.firstObject And secondObject
** Type: object
** Description : return objType {seviceTag and objectType} And identifiers
* queryResult.relId
** Type: string
* queryResult.relType
** Type: object
** Description: return {seviceTag and relationshipTag}
* queryResult.relationshipDirection
** Type: string
* queryResult.updatePropertiesParam
** Type: object
** Description: return properties to updated
* queryResult.oldRelationshipProperties
** Type: object
** Description: return old properties before update
* queryResult.newRelationshipProperties
** Type: object
** Description: return new properties after updated
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type : string
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
firstObject: {
objType: {
serviceTag: "string",
objectType: "string"
},
identifiers: {
//…identifiers
}
},
secondObject: {
objType: {
serviceTag: "string",
objectType: "string"
},
identifiers: {
//…identifiers
}
},
relId: "string",
relType: {
serviceTag: "string",
relationshipTag: "string"
},
relationshipDirection: "string",
updatePropertiesParam: {
//… properties updated
},
oldRelationshipProperties: {
// … old properties before update
},
newRelationshipProperties: {
//… new properties after updated
}
}
},
requestParams: {
// return example send param
},
parentFlowId:"",
status: “string”, // "complete",”error”
errorsFound: []
}
</syntaxhighlight>

== GetNodeAndRelationship ==
=== Request Parameters ===
* sourceObjType
** Required: true
** Description: has serviceTag and objectType
* sourceIdentifiers
** Type: object
** Required: true
* sourceVersionedDataLabels
** Type: object
** Required: optional
* targetRelationships
** Type: Array
** Required: true
* relTypeAndDirection
** Type: object
** Required: true
* relTypeAndDirection.relType
** Type: object
** Required: true
** Description: has serviceTag and relationshipTag
* relTypeAndDirection.relationshipProperties
** Type: object
** Required: optional
* relTypeAndDirection.relationshipDirection
** Type: String
** Required: optional
* targetObjects
** Type: Array
** Required: Optional
* targetObjects.objType
** Type: object
** Required: required if send targetObjects in param
* targetObjects.identifiers
** Type: object
** Required: optional should have objType if identifiers exists
* targetObjects.versionedDataLabels
** Type: object
** Required: optional have objType if versionedDataLabels exists

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"sourceObjType": { // required
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"sourceIdentifiers": {}, // required
"sourceVersionedDataLabels": [], // optional
"targetRelationships": [ //required
{
"relTypeAndDirection": { // required
"relType": {
"serviceTag": "xxxx",
"relationshipTag": "rel"
},
"relationshipProperties": {},//optional
"relationshipDirection": "" // required
},
"targetObjects": [ // optional
{
"objType": {
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"identifiers": {}, // optional
"versionedDataLabels": [] // optional have objType if versionedDataLabels exists
}
]
},
// if have multiple relTypeAndDirection
],
"settings": {} // defaulf = false >>> if have versionedDataLabels want to return all field of versionedata: settings = { returnSystemFieldsName: true }
"parentFlowId": "" // optional
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.objTypes
** Type: array of object
** Description: return {serviceTag and objectType}
* queryResult.objInstanceFull
** Type: object
** Description: return {identifiers and fields}
* queryResult.relNodes:
** Type: array
* relNodes.relType
** Type: object
** Description: return {serviceTag and relationshipTag}
* relNodes.relationshipProperties
** Type: object
* relNodes.objTypes
** Type: array of object
** Description: return {serviceTag and objectType}
* relNodes.objInstanceFull
** Type: object
** Description: return {identifiers and fields}
* requestParams
** Type: object
** Description: return same requestParams
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: {},
fields: { }
},
relNodes: [
{
relType: {
serviceTag: 'xxxx',
relationshipTag: 'rel'
},
relationshipProperties: { },
objTypes: [
{
serviceTag: 'xxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: {},
fields: {
// field
}
},
versionDataSystemFields: {
'0VersionDataLabel': {
originTimestamp:
forMatchedId:
versionedDataId:
}
}
}
]
}
},
requestParam : {
// return example send param
},
errorsFound: [],
graphServiceTag: "GraphHandler"
}

</syntaxhighlight>

== ChangeRelationshipType ==
=== Request Parameters ===
* firstObject
** Type : object
** Required : true
* secondObject
** Type : object
** Required : true
* objType
** Type : object
** Required : true
* Identifiers
** Type : object
** Required : true
* oldRelTypeAndDirection
** Type : object
** Required : true
* oldRelTypeAndDirection.relType
** Type : object
** Required : true
* oldRelTypeAndDirection.relationshipDirection
** Type : string
** Required : true
* oldRelTypeAndDirection.relationshipProperties
** Type : object
** Required : optional
* newRelType
** Type : object
** Required : true
* originTimestamp
** Type : number
** Required : true
* changedByUserId
** Type : String
** Required : true
* callingFlow
** Type : String
** Required : optional
* settings
** Type : object
** Required : optional
** Description : default > settings.changeMultipleRelationships : false // if send settings.changeMultipleRelationships : true >> can change multiple relType

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"secondObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"oldRelTypeAndDirection":{
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"old"
},
"relationshipDirection":"from",
"relationshipProperties":{
//Properties
}
},
"newRelType":{
"serviceTag":"xxxx",
"relationshipTag":"new"
},
"originTimestamp":1234567890,
"changedByUserId":"xxxx",
"callingFlow":"yyyy",
"settings":{
"changeMultipleRelationships": boolean: // default false
}
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.newRelationshipType
** Type: object
* newRelationshipType.relType
** Type: object
* newRelationshipType.relationshipDirection
** Type: string
* newRelationshipType.relationshipProperties
** Type: object
* queryResult.oldRelationshipType
** Type: object
* oldRelationshipType.relType
** Type: object
* oldRelationshipType.relationshipDirection
** Type: string
* oldRelationshipType.relationshipProperties
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
newRelationshipType: {
relType: {
serviceTag: "xxxx",
relationshipTag: "new"
},
relationshipDirection: "" // 'from' or 'to'
relationshipProperties: {}
},
oldRelationshipType: {
relType: {
serviceTag: "xxxx",
relationshipTag: "old"
},
relationshipDirection: "" // 'from' or 'to'
relationshipProperties: {}
}
},
requestParams : {
// return example send param
}
},
status: "complete" // or error,
errorsFound: [],
graphServiceTag : 'GraphHandeler'
}

</syntaxhighlight>

== DeleteRelationship ==
=== Request Parameters ===
* fromObject
** Type : object
** Required : optional
* secondObject
** Type : object
** Required : optional
* objType
** Type : object
** Required : true
* Identifiers
** Type : object
** Required : true
* relType
** Type : object
** Required : true
* relId
** Type: string
** Required : true
* relationshipDirection
** Type: string
** Required : optional
* callingFlow
** Type: string
** Required : true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"yyyy"
},
"relId":"string"
},
"relationshipDirection":"string"// "from" or "to"
"callingFlow":"string"
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.objects
** Type: array
* queryResult.objTypes
** Type: array
* queryResult.objInstanceFull.identifiers
** Type: object
* queryResult.objInstanceFull.fields
** Type: object
** Description: return data of fromObject and secondObject
* queryResult.userNode
** Type: object
** Description: return data of userNode
* queryResult.resultDeleteRel
** Type : string
** Description: return status Relationship Delete
* requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objects: [
{
objTypes: [
{
serviceTag: "xxxx",
objectType: "yyyy"
}
],
objInstanceFull: {
identifiers: {
// identifiers
},
fields: {
// fields
}
}
},
{
// if have multiple object objTypes
}
],
userNode: {
objTypes: [
{
serviceTag: "UserAccount",
objectType: "user"
}
],
objInstanceFull: {
identifiers: {
userId: "zzz"
}
}
},
resultDeleteRel: "Relationship Deleted" // default
},
requeatParam: {
// return example send param
},
status: "string", //default "complete" or "error"
errorsFound: []
}
}

</syntaxhighlight>

== DeleteNode ==
=== Request Parameters ===
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* identifiers
** Type : object
** Required: true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":"xxx",
"objectType":"yyy"
},
"identifiers":{
//
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResults
** Type: object
* queryResults.resultDeleteNode
** Type: Boolean
** Description: return status deleted node >> true or false
* requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
** Description: return status deleted node >> complete or error
* errorsFound
** Type: array
* graphServiceTag
** Type: string
=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: { resultDeleteNode: true }, // true or false
requestParams: {
// return example send param
}
},
status: 'string', // 'complete' or 'error'
errorsFound: [],
graphServiceTag: 'GraphHandler'
}
</syntaxhighlight>

== MoveRelationship ==

=== Request Parameters ===
* sourceObject
** Type : object
** Required : true
** Description: required objType: {serviceTag , objectType} and identifiers
* targetObjType
** Type : object
** Required : true
** Description: required objType: {serviceTag , objectType}
* relType
** Type : object
** Required : true
** Description: required objType: {serviceTag , relationshipTag}
* relationshipDirection
** Type : object
** Required : true
* moveToIdentifiers
** Type : object
** Required : true
* moveByUserId
** Type : String
** Required : true
* originTimestamp
** Type : number
** Required : true
* settings
** Type : object
** Required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"sourceObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyy"
},
"identifiers":{
// identifiers
}
},
"targetObjType":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
}
},
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"rel"
},
"relationshipDirection":"from", // "to"
"moveToIdentifiers":{
// target identifiers
},
"moveByUserId":"xxxx",
"originTimestamp":1234567890,
"settings":{}
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.moveRelationship
** Type: object
* moveRelationship.sourceObject
** Type: object
** Description: return data of sourceObject
* moveRelationship.relationship
** Type: string
** Description: return data of after move relationship
* moveRelationship.moveToObject
** Type: object
** Description: return data of moveToObject
* moveRelationship.historyData
** Type: object
** Description: return properties {old target identifiers and originTimestamp} after moveRelationship
* moveRelationship.userNode
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
moveRelationship: {
sourceObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
}
},
relationship: {
relType: {
serviceTag: 'xxxx',
relationshipTag: 'rel'
},
relationshipProperties: { originTimestamp: 1234567890 }
},
moveToObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: { }
},
historyData: {
relationshipProperties: { }
},
userNode: {
objTypes: [{ serviceTag: 'UserAccount', objectType: 'user' }],
objInstanceFull: { }
}
}
},
requestParam: {
}
}
status: "complete" // or error,
errorsFound: [],
graphServiceTag: 'GraphHandler'
}

</syntaxhighlight>

== MoveNodeProperties ==
=== Request Parameters ===
* sourceObject
** type: object
** required : true
* targetIdentifiers
** type : object
** required : true
* moveProperties
** type : array
** required : true // index minimum = 1
* updateProperties
** type : object
** required : true
* movePropertiesConditions
** type : array
** required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
sourceObject: {
objType: { },
identifier: { }
},
targetIdentifiers: { },
moveProperties: [ ],
updateProperties: { },
movePropertiesConditions: [ // optional
{
checkObject: 'target', // "source" | "target"
onSetObject: 'target', // "source" | "target"
onPassValue: true,
onNotPassCondition: false, // optional
fieldNameConditions: [ ]
}
]
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.moveNodeProperties
** Type: object
* moveNodeProperties.sourceObject
** Type: object
** Description: return data of sourceObject
* moveRelationship.moveFieldToObject
** Type: string
** Description: return data after moveFieldToObject
* moveRelationship.movedFields
** Type: object
** Description: return data field of moveToObject
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String
=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
moveNodeProperties: {
sourceObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: {
identifiers: { },
fields: { }
}
},
moveFieldToObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: { },
fields: {

}
},
movedFields: { Fields: { } } //
}
}
},
requestParam: { },
status: 'complete',
errorsFound: [],
graphServiceTag: 'GraphHandler'
}
</syntaxhighlight>
[[Category:Working documents| 2025-03-06]]

2025-03-06 - Graph Handler Docs

2026-06-11T07:24:04Z

Seagame: /* GetNodes */

= GraphHandler Function =
== CreateNode ==
'''Use Case of CreateNode''' >>> https://izara.io/wiki/index.php/2025-03-27_Graph_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
* setFieldConditionals
** type : array
** Required : optional
* deepPathConditional
** type : array
** Required : optional
* parentFlowId
** type : string
** Required: true
* callingFlowConfig
** Type: object
** Required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType": {
"objectType": string,
"serviceTag": string
},
"objInstanceFull": {
"identifiers": {
// ...identifier
},
"fields": {
// ...fields
}
},
setFieldConditionals: [ // optional default array
{
objType: { },
indexValue: { nameSpace: 'ex-011', systemTextTag: 'Gate-011' }, // index field : value
fieldName: '', // fieldName want to set
passValue: 'false', optional
notPassValue: 'true', //optional
conditionals: [ optional ] // condition check field
}
],
"relationships": [
{
"relType": {
"serviceTag": string,
"relationshipTag": string
},
"relationshipProperties": {
//... key and value of targetIdentifiers
},
"relationshipDirection": string, // "from" | "to"
"targetObjType": {
"serviceTag": string,
"objectType": string
},
"targetIdentifiers": {
//... targetIdentifiers
}
}
],
deepPathConditional: [ // optional default array
{
condition: 'notExist', //
conditionCheck: { // traversal
nodeStructure: {
objType: { },
fields: { }
},
nextPath: {
relationshipStructure: {
relType: { },
relationshipDirection: 'to'
},
nodeStructure: {
objType: { },
fields: { }
}
}
}
}
],
"originTimestamp": number, // timestamp when create
"settings": {
"updatePropertiesOnMatch": boolean // default=false
},
"parentFlowId": "", // required
"callingFlow": string,
"callingFlowProperties": object,
}
</syntaxhighlight>

=== 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.relationships
** Type: array
** Description: data from relationships in targetNode
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* Status
** Type: string
** Description: Status from create node. Return "error" or "complete".
* errorsFound
** Type: array
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">

{
returnValue: {
queryResult: {
returnCreateNode: {
objTypes: [
{
serviceTag: "string",
objectType: "string"
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//...fields
}
},
existsNode: { },
userNode: { // // if has userNode send to createNode
objTypes: [
{
"serviceTag": "UserAccount",
"objectType": "user"
}
],
properties: {
//...properties
}
},
relationships: [ // optional : if has requiredOnCreated , createNode with targetNode
{
objTypes: [
{ serviceTag: 'string', objectType: 'string' }
],
objInstanceFull: {
identifiers: {
// identifiers
}
},
relType: {
serviceTag: 'string',
relationshipTag: 'rel'
},
relationshipProperties: {
// properties
}
},
]
}
},
requestParams: {
// return example send param
},
parentFlowId:""
},
status: "string", // "complete' or "error"
errorsFound: [],
graphServiceTag: "GraphHandler"
}

</syntaxhighlight>

== GetNode ==
'''Use Case of GetNode''' >>> https://izara.io/wiki/index.php/2025-04-23_Graph_Use_Case/GetNode_and_GetNodes#Use_Case_GetNodes
=== 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
* versionedDataLabels
** Type: Array
** Required : optional
* settings.updatePropertiesOnMatch
** Type: Boolean
** Required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":string,
"objectType":string
},
"objInstanceFull":{
"identifiers":{
// ...identifier
},
"fields":{
// ...fields
}
},
"versionedDataLabels":[
//…versionedData
],
"settings": {
"returnSystemFieldsName" :boolean // default = true or false
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* returnValue.queryResult
** Type: object
* queryResult.refactoredNodes
** Type: object
** Description: return object from getNode
* refactoredNodes.objTypes
** Type: array
* refactoredNodes.objInstanceFull
** Type: object
* refactoredNodes.objInstanceFull.identifiers
** Type: object
* refactoredNodes.objInstanceFull.fields
** Type: object
* refactoredNodes.versionDataSystemFields
** Type: object
* refactoredNodes.versionDataSystemFields.versionedDataLabel
** Type: object
* queryResult.requestParam
** Type: object
** Description: return example send param
* errorsFound
** Type: string
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
refactoredNodes: {
objTypes: [
{
serviceTag: "string",
objectType: "string",
}
],
objInstanceFull: {
identifiers: {
//… identifier
},
fields: {
//…fields
}
},
versionDataSystemFields: {
versionedDataLabel: {
originTimestamp: number,
forMatchedId: "string",
versionedDataId: "string"
}
}
}
},
requestParam: {
// return example send param
}
},
errorsFound: [],
graphServiceTag: ''
}
</syntaxhighlight>

== GetNodes ==
'''Use Case of GetNodes''' >>> https://izara.io/wiki/index.php/2025-04-23_Graph_Use_Case/GetNode_and_GetNodes#Use_Case_GetNodes
=== Request Parameters ===
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* fields
** Type : object
** Required: true
* versionedDataLabels
** Type: Array
** Required : optional
* settings.returnSystemFieldsName
** Type: Boolean
** Required : optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":string,
"objectType":string
},
"fields":{
//…fields with matching value
},
"versionedDataLabels":[
//…versionedDataLabels
],
"settings":{
"returnSystemFieldsName":boolean // default=false
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResults
** Type: object
* queryResults.getNodesReturnValues
** Type: array
* getNodesReturnValues.objTypes
** Type: array
* getNodesReturnValues.objInstanceFull
** Type: object
* getNodesReturnValues.objInstanceFull.identifiers
** Type: object
* getNodesReturnValues.objInstanceFull.fields
** Type: object
* getNodesReturnValues.versionDataSystemFields
** Type: object
* getNodesReturnValues.versionDataSystemFields.versionedDataLabel
** Type: object
* requestParams
** Type: object
* errorsFound
** Type: string
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: {
getNodesReturnValues: [
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//.. all fields-1
}
},
versionDataSystemFields: {}
},
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//...all fields-2
}
},
versionDataSystemFields: {
versionedDataLabel: {
originTimestamp: number,
forMatchedId: 'string',
versionedDataId: 'string'
}
}
}
]
},
requestParams: {
// return example send param
}
}
}
</syntaxhighlight>

== UpdateNode ==
''' Use Case of UpdateNode''' >>> https://izara.io/wiki/index.php/2025-08-03_-_Graph_Use_Case/UpdateNode
=== 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: object
** Required : true
* objInstanceFull.fields
** Type : object
** Required: true
** Description : can not send fields to update mainNode and versionedData together
* versionedDataIds
** Type: object
** Required: optional
* originTimestamp
** Type: number
** Required: true
* settings
** Type: object
** Required: optional
* parentFlowId
** type : string
** Required: true
* callingFlow
** Type: string
** Required: optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType": {
"serviceTag": string,
"objectType": string
},
"objInstanceFull": {
"identifiers": {
//…identifiers
},
"fields": {
//…fields
// can not be send fields of mainNode and versionedData in fields together!
}
},
"versionedDataIds": {},
"originTimestamp": number, //// timestamp when update
"settings": {},
"parentFlowId": ""// required
"callingFlow": string
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* returnValue.queryResult
** Type: object
** Description: data from created node
* queryResult.objTypes
** Type: array
** Description: serviceTag and objectType
* queryResult.objInstanceFull
** Type: object
** Description: identifiers and fields
* queryResult.userId
** Type: object
** Description: data that update from user Account
* queryResult.versionDataSystemFields
** Type: object
** Description: optional return versionedData
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* returnValue.Status
** Type: string
** Description: status from updated node // error or complete
* returnValue.errorsFound
** Type: array
* returnValue.graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifiers
},
fields: {
//...fields
}
},
userId: {
// if have userNode send to updated
},
versionDataSystemFields: {
versionedDataLabel: {
}
}
},
requestParams: {
// return example send param
},
parentFlowId:""
},
status: 'string',//"complete" // "error"
errorsFound: [],
graphServiceTag: 'string'
}
</syntaxhighlight>

== CreateRelationship ==
''' Use Case of CreateRelationship''' >>> https://izara.io/wiki/index.php/2025-08-01_-_Graph_Use_Case/CreateRelationship
=== Request Parameters ===
* firstObject
** Type: object
** Required: true
* secondObject
** Type: object
** Required: true
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* identifiers
** Type: object
** Required : true
* additionalRelationships
** Type: array of object
** Required: optional
* relType
** Type: object
** Required: true
* relationshipDirection
** Type: string
** Required: true
* relationshipProperties
** Type: object
** Required: true
* deepPathConditional
** Type : array
** Required: optional
** Description : using deepPathConditional for check relationship if not exist , can check on firstNode and seconNode or additionalRelationships
* Settings
** Type: object
** Required: true
* settings.updateRelPropsWhenExist
** Type: boolean
** Required: optional
* parentFlowId
** type : string
** Required: true
* callingFlow
** Type: string
** Required: optional
* callingFlowConfig
** Type: object
** Required: optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject": {
"objType": {
"serviceTag": string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"additionalRelationships": [
{
"objType": {
"serviceTag":string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"relType": {
"serviceTag":string,
"relationshipTag":string
},
"relationshipProperties": {
//…properties
},
"relationshipDirection":string ,// “from” , “to”
"deepPathConditional": []
}
]
},
"secondObject": {
"objType": {
"serviceTag":string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"additionalRelationships": [
//…optional
]
},
"relType": {
"serviceTag":string,
"relationshipTag":string
},
"relationshipDirection":string, // “from” , “to”
"relationshipProperties": {
//…properties
},
"deepPathConditional": [ // default []
{
condition: 'notExist',
conditionCheck: {
nodeStructure: {
objType: {

},
fields: { }
},
nextPath: {
relationshipStructure: {
relType: {

},
relationshipDirection: ''
},
nodeStructure: {
objType: {

},
fields: { }
}
}
}
}
]
"settings": {
"reateOnConditionalFail": false // true default = false
"updateRelPropsWhenExist": boolean,
},
"parentFlowId": "", // required
"callingFlow": "xxxx",
"callingFlowProperties": {
"graphServiceName": string
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.relationship
** Type: object
* queryResult.relationship.relType
** Type: object
* queryResult.relationship.relationshipProperties
** Type: object
* queryResult.firstNode
** Type: object
** Description: return data structure from firstNode
* queryResult.secondNode
** Type: object
** Description: return data structure from secondNode
* queryResult..onCreateAddRelationships
** Type: array
** Description: return data structure from onCreateAddRelationships
* returnValue.firstObject
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* Status
** Type: string
** Description: status from create node // error or complete
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
relationship: {
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//…properties
}
},
firstNode: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: { //… identifiers },
fields: {
//… all fields
}
},
onCreateAddRelationships: [
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//… identifiers
},
fields: {
//… all fields
}
},
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//… all properties
}
}
]
},
secondNode: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: { //… identifiers },
fields: {
//… all fields
}
},
onCreateAddRelationships: [
//… optional
]
}
}
}
}
requestParams: {
// return example send param

},
parentFlowId: "",
Status: 'string', //“complete” // “error”
errorsFound: []
}
}
</syntaxhighlight>

== GetRelationship ==
=== Request Parameters ===
* firstObject
** Type: object
** Required: optional
* secondObject
** Type: object
** Required: optional
* objType
** Type: object
** Required: true
** Description: has serviceTag and objectType
* identifiers
** Type: object
** Required: true
* relType
** Type: object
** Required: true
** Description: has relationshipTag and serviceTag
* relId
** Type: string
** Required: true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag":string,
"objectType":string
},
"identifiers":{
//…identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"relType":{ // required
"relationshipTag": string,
"serviceTag": string
},
"relId": 'string' // // required,
"parentFlowId": "" // optional
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
* Type: object
* queryResult.relType
** Type: object
* queryResult.relationshipProperties
** Type: object
** Description: return relId and properties
* returnValue.toObject
** Type: object
** Description: return toObject if not send secondObject from param
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* errorsFound
** Type: array
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: {
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//…properties : 'string’
}
},
toObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: {
identifiers: {
//
},
fields: { }
}
},
requestParams: {
// return example send param
}
}
}

</syntaxhighlight>

== UpdateRelationship ==
=== Request Parameters ===
* firstObject
** Type: object
** Required: optional
* secondObject
** Type: object
** Required: Optional
* objType
** Type: object
** Required: true
** Description: has serviceTag and objectType
* identifiers
** Type: object
** Required: true
* relId
** Type: string
** Required: true
* relType
** Type: object
** Required: true
** Description: has relationshipTag and serviceTag
* relationshipProperties
** Type: object
** Required: true
** Description: send properties that want to update
* relationshipDirection
** Type: string
** Required: optional
* parentFlowId
** Type : string
** Required : true
* callingFlow
** Type: string
** Required: optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"relId": string,
"relType":{
"serviceTag":string,
"relationshipTag":string
},
"relationshipProperties":{
//… properties that want to update
},
"relationshipDirection": string, // "from" // “to”
"parentFlowId": ""// required
"callingFlow": string
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.firstObject And secondObject
** Type: object
** Description : return objType {seviceTag and objectType} And identifiers
* queryResult.relId
** Type: string
* queryResult.relType
** Type: object
** Description: return {seviceTag and relationshipTag}
* queryResult.relationshipDirection
** Type: string
* queryResult.updatePropertiesParam
** Type: object
** Description: return properties to updated
* queryResult.oldRelationshipProperties
** Type: object
** Description: return old properties before update
* queryResult.newRelationshipProperties
** Type: object
** Description: return new properties after updated
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type : string
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
firstObject: {
objType: {
serviceTag: "string",
objectType: "string"
},
identifiers: {
//…identifiers
}
},
secondObject: {
objType: {
serviceTag: "string",
objectType: "string"
},
identifiers: {
//…identifiers
}
},
relId: "string",
relType: {
serviceTag: "string",
relationshipTag: "string"
},
relationshipDirection: "string",
updatePropertiesParam: {
//… properties updated
},
oldRelationshipProperties: {
// … old properties before update
},
newRelationshipProperties: {
//… new properties after updated
}
}
},
requestParams: {
// return example send param
},
parentFlowId:"",
status: “string”, // "complete",”error”
errorsFound: []
}
</syntaxhighlight>

== GetNodeAndRelationship ==
=== Request Parameters ===
* sourceObjType
** Required: true
** Description: has serviceTag and objectType
* sourceIdentifiers
** Type: object
** Required: true
* sourceVersionedDataLabels
** Type: object
** Required: optional
* targetRelationships
** Type: Array
** Required: true
* relTypeAndDirection
** Type: object
** Required: true
* relTypeAndDirection.relType
** Type: object
** Required: true
** Description: has serviceTag and relationshipTag
* relTypeAndDirection.relationshipProperties
** Type: object
** Required: optional
* relTypeAndDirection.relationshipDirection
** Type: String
** Required: optional
* targetObjects
** Type: Array
** Required: Optional
* targetObjects.objType
** Type: object
** Required: required if send targetObjects in param
* targetObjects.identifiers
** Type: object
** Required: optional should have objType if identifiers exists
* targetObjects.versionedDataLabels
** Type: object
** Required: optional have objType if versionedDataLabels exists

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"sourceObjType": { // required
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"sourceIdentifiers": {}, // required
"sourceVersionedDataLabels": [], // optional
"targetRelationships": [ //required
{
"relTypeAndDirection": { // required
"relType": {
"serviceTag": "xxxx",
"relationshipTag": "rel"
},
"relationshipProperties": {},//optional
"relationshipDirection": "" // required
},
"targetObjects": [ // optional
{
"objType": {
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"identifiers": {}, // optional
"versionedDataLabels": [] // optional have objType if versionedDataLabels exists
}
]
},
// if have multiple relTypeAndDirection
],
"settings": {} // defaulf = false >>> if have versionedDataLabels want to return all field of versionedata: settings = { returnSystemFieldsName: true }
"parentFlowId": "" // optional
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.objTypes
** Type: array of object
** Description: return {serviceTag and objectType}
* queryResult.objInstanceFull
** Type: object
** Description: return {identifiers and fields}
* queryResult.relNodes:
** Type: array
* relNodes.relType
** Type: object
** Description: return {serviceTag and relationshipTag}
* relNodes.relationshipProperties
** Type: object
* relNodes.objTypes
** Type: array of object
** Description: return {serviceTag and objectType}
* relNodes.objInstanceFull
** Type: object
** Description: return {identifiers and fields}
* requestParams
** Type: object
** Description: return same requestParams
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: {},
fields: { }
},
relNodes: [
{
relType: {
serviceTag: 'xxxx',
relationshipTag: 'rel'
},
relationshipProperties: { },
objTypes: [
{
serviceTag: 'xxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: {},
fields: {
// field
}
},
versionDataSystemFields: {
'0VersionDataLabel': {
originTimestamp:
forMatchedId:
versionedDataId:
}
}
}
]
}
},
requestParam : {
// return example send param
},
errorsFound: [],
graphServiceTag: "GraphHandler"
}

</syntaxhighlight>

== ChangeRelationshipType ==
=== Request Parameters ===
* firstObject
** Type : object
** Required : true
* secondObject
** Type : object
** Required : true
* objType
** Type : object
** Required : true
* Identifiers
** Type : object
** Required : true
* oldRelTypeAndDirection
** Type : object
** Required : true
* oldRelTypeAndDirection.relType
** Type : object
** Required : true
* oldRelTypeAndDirection.relationshipDirection
** Type : string
** Required : true
* oldRelTypeAndDirection.relationshipProperties
** Type : object
** Required : optional
* newRelType
** Type : object
** Required : true
* originTimestamp
** Type : number
** Required : true
* changedByUserId
** Type : String
** Required : true
* callingFlow
** Type : String
** Required : optional
* settings
** Type : object
** Required : optional
** Description : default > settings.changeMultipleRelationships : false // if send settings.changeMultipleRelationships : true >> can change multiple relType

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"secondObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"oldRelTypeAndDirection":{
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"old"
},
"relationshipDirection":"from",
"relationshipProperties":{
//Properties
}
},
"newRelType":{
"serviceTag":"xxxx",
"relationshipTag":"new"
},
"originTimestamp":1234567890,
"changedByUserId":"xxxx",
"callingFlow":"yyyy",
"settings":{
"changeMultipleRelationships": boolean: // default false
}
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.newRelationshipType
** Type: object
* newRelationshipType.relType
** Type: object
* newRelationshipType.relationshipDirection
** Type: string
* newRelationshipType.relationshipProperties
** Type: object
* queryResult.oldRelationshipType
** Type: object
* oldRelationshipType.relType
** Type: object
* oldRelationshipType.relationshipDirection
** Type: string
* oldRelationshipType.relationshipProperties
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
newRelationshipType: {
relType: {
serviceTag: "xxxx",
relationshipTag: "new"
},
relationshipDirection: "" // 'from' or 'to'
relationshipProperties: {}
},
oldRelationshipType: {
relType: {
serviceTag: "xxxx",
relationshipTag: "old"
},
relationshipDirection: "" // 'from' or 'to'
relationshipProperties: {}
}
},
requestParams : {
// return example send param
}
},
status: "complete" // or error,
errorsFound: [],
graphServiceTag : 'GraphHandeler'
}

</syntaxhighlight>

== DeleteRelationship ==
=== Request Parameters ===
* fromObject
** Type : object
** Required : optional
* secondObject
** Type : object
** Required : optional
* objType
** Type : object
** Required : true
* Identifiers
** Type : object
** Required : true
* relType
** Type : object
** Required : true
* relId
** Type: string
** Required : true
* relationshipDirection
** Type: string
** Required : optional
* callingFlow
** Type: string
** Required : true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"yyyy"
},
"relId":"string"
},
"relationshipDirection":"string"// "from" or "to"
"callingFlow":"string"
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.objects
** Type: array
* queryResult.objTypes
** Type: array
* queryResult.objInstanceFull.identifiers
** Type: object
* queryResult.objInstanceFull.fields
** Type: object
** Description: return data of fromObject and secondObject
* queryResult.userNode
** Type: object
** Description: return data of userNode
* queryResult.resultDeleteRel
** Type : string
** Description: return status Relationship Delete
* requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objects: [
{
objTypes: [
{
serviceTag: "xxxx",
objectType: "yyyy"
}
],
objInstanceFull: {
identifiers: {
// identifiers
},
fields: {
// fields
}
}
},
{
// if have multiple object objTypes
}
],
userNode: {
objTypes: [
{
serviceTag: "UserAccount",
objectType: "user"
}
],
objInstanceFull: {
identifiers: {
userId: "zzz"
}
}
},
resultDeleteRel: "Relationship Deleted" // default
},
requeatParam: {
// return example send param
},
status: "string", //default "complete" or "error"
errorsFound: []
}
}

</syntaxhighlight>

== DeleteNode ==
=== Request Parameters ===
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* identifiers
** Type : object
** Required: true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":"xxx",
"objectType":"yyy"
},
"identifiers":{
//
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResults
** Type: object
* queryResults.resultDeleteNode
** Type: Boolean
** Description: return status deleted node >> true or false
* requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
** Description: return status deleted node >> complete or error
* errorsFound
** Type: array
* graphServiceTag
** Type: string
=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: { resultDeleteNode: true }, // true or false
requestParams: {
// return example send param
}
},
status: 'string', // 'complete' or 'error'
errorsFound: [],
graphServiceTag: 'GraphHandler'
}
</syntaxhighlight>

== MoveRelationship ==

=== Request Parameters ===
* sourceObject
** Type : object
** Required : true
** Description: required objType: {serviceTag , objectType} and identifiers
* targetObjType
** Type : object
** Required : true
** Description: required objType: {serviceTag , objectType}
* relType
** Type : object
** Required : true
** Description: required objType: {serviceTag , relationshipTag}
* relationshipDirection
** Type : object
** Required : true
* moveToIdentifiers
** Type : object
** Required : true
* moveByUserId
** Type : String
** Required : true
* originTimestamp
** Type : number
** Required : true
* settings
** Type : object
** Required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"sourceObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyy"
},
"identifiers":{
// identifiers
}
},
"targetObjType":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
}
},
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"rel"
},
"relationshipDirection":"from", // "to"
"moveToIdentifiers":{
// target identifiers
},
"moveByUserId":"xxxx",
"originTimestamp":1234567890,
"settings":{}
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.moveRelationship
** Type: object
* moveRelationship.sourceObject
** Type: object
** Description: return data of sourceObject
* moveRelationship.relationship
** Type: string
** Description: return data of after move relationship
* moveRelationship.moveToObject
** Type: object
** Description: return data of moveToObject
* moveRelationship.historyData
** Type: object
** Description: return properties {old target identifiers and originTimestamp} after moveRelationship
* moveRelationship.userNode
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
moveRelationship: {
sourceObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
}
},
relationship: {
relType: {
serviceTag: 'xxxx',
relationshipTag: 'rel'
},
relationshipProperties: { originTimestamp: 1234567890 }
},
moveToObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: { }
},
historyData: {
relationshipProperties: { }
},
userNode: {
objTypes: [{ serviceTag: 'UserAccount', objectType: 'user' }],
objInstanceFull: { }
}
}
},
requestParam: {
}
}
status: "complete" // or error,
errorsFound: [],
graphServiceTag: 'GraphHandler'
}

</syntaxhighlight>

== MoveNodeProperties ==
=== Request Parameters ===
* sourceObject
** type: object
** required : true
* targetIdentifiers
** type : object
** required : true
* moveProperties
** type : array
** required : true // index minimum = 1
* updateProperties
** type : object
** required : true
* movePropertiesConditions
** type : array
** required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
sourceObject: {
objType: { },
identifier: { }
},
targetIdentifiers: { },
moveProperties: [ ],
updateProperties: { },
movePropertiesConditions: [ // optional
{
checkObject: 'target', // "source" | "target"
onSetObject: 'target', // "source" | "target"
onPassValue: true,
onNotPassCondition: false, // optional
fieldNameConditions: [ ]
}
]
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.moveNodeProperties
** Type: object
* moveNodeProperties.sourceObject
** Type: object
** Description: return data of sourceObject
* moveRelationship.moveFieldToObject
** Type: string
** Description: return data after moveFieldToObject
* moveRelationship.movedFields
** Type: object
** Description: return data field of moveToObject
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String
=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
moveNodeProperties: {
sourceObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: {
identifiers: { },
fields: { }
}
},
moveFieldToObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: { },
fields: {

}
},
movedFields: { Fields: { } } //
}
}
},
requestParam: { },
status: 'complete',
errorsFound: [],
graphServiceTag: 'GraphHandler'
}
</syntaxhighlight>
[[Category:Working documents| 2025-03-06]]

2025-03-06 - Graph Handler Docs

2026-06-11T06:39:35Z

Seagame: /* GetNode */

= GraphHandler Function =
== CreateNode ==
'''Use Case of CreateNode''' >>> https://izara.io/wiki/index.php/2025-03-27_Graph_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
* setFieldConditionals
** type : array
** Required : optional
* deepPathConditional
** type : array
** Required : optional
* parentFlowId
** type : string
** Required: true
* callingFlowConfig
** Type: object
** Required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType": {
"objectType": string,
"serviceTag": string
},
"objInstanceFull": {
"identifiers": {
// ...identifier
},
"fields": {
// ...fields
}
},
setFieldConditionals: [ // optional default array
{
objType: { },
indexValue: { nameSpace: 'ex-011', systemTextTag: 'Gate-011' }, // index field : value
fieldName: '', // fieldName want to set
passValue: 'false', optional
notPassValue: 'true', //optional
conditionals: [ optional ] // condition check field
}
],
"relationships": [
{
"relType": {
"serviceTag": string,
"relationshipTag": string
},
"relationshipProperties": {
//... key and value of targetIdentifiers
},
"relationshipDirection": string, // "from" | "to"
"targetObjType": {
"serviceTag": string,
"objectType": string
},
"targetIdentifiers": {
//... targetIdentifiers
}
}
],
deepPathConditional: [ // optional default array
{
condition: 'notExist', //
conditionCheck: { // traversal
nodeStructure: {
objType: { },
fields: { }
},
nextPath: {
relationshipStructure: {
relType: { },
relationshipDirection: 'to'
},
nodeStructure: {
objType: { },
fields: { }
}
}
}
}
],
"originTimestamp": number, // timestamp when create
"settings": {
"updatePropertiesOnMatch": boolean // default=false
},
"parentFlowId": "", // required
"callingFlow": string,
"callingFlowProperties": object,
}
</syntaxhighlight>

=== 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.relationships
** Type: array
** Description: data from relationships in targetNode
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* Status
** Type: string
** Description: Status from create node. Return "error" or "complete".
* errorsFound
** Type: array
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">

{
returnValue: {
queryResult: {
returnCreateNode: {
objTypes: [
{
serviceTag: "string",
objectType: "string"
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//...fields
}
},
existsNode: { },
userNode: { // // if has userNode send to createNode
objTypes: [
{
"serviceTag": "UserAccount",
"objectType": "user"
}
],
properties: {
//...properties
}
},
relationships: [ // optional : if has requiredOnCreated , createNode with targetNode
{
objTypes: [
{ serviceTag: 'string', objectType: 'string' }
],
objInstanceFull: {
identifiers: {
// identifiers
}
},
relType: {
serviceTag: 'string',
relationshipTag: 'rel'
},
relationshipProperties: {
// properties
}
},
]
}
},
requestParams: {
// return example send param
},
parentFlowId:""
},
status: "string", // "complete' or "error"
errorsFound: [],
graphServiceTag: "GraphHandler"
}

</syntaxhighlight>

== GetNode ==
'''Use Case of GetNode''' >>> https://izara.io/wiki/index.php/2025-04-23_Graph_Use_Case/GetNode_and_GetNodes#Use_Case_GetNodes
=== 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
* versionedDataLabels
** Type: Array
** Required : optional
* settings.updatePropertiesOnMatch
** Type: Boolean
** Required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":string,
"objectType":string
},
"objInstanceFull":{
"identifiers":{
// ...identifier
},
"fields":{
// ...fields
}
},
"versionedDataLabels":[
//…versionedData
],
"settings": {
"returnSystemFieldsName" :boolean // default = true or false
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* returnValue.queryResult
** Type: object
* queryResult.refactoredNodes
** Type: object
** Description: return object from getNode
* refactoredNodes.objTypes
** Type: array
* refactoredNodes.objInstanceFull
** Type: object
* refactoredNodes.objInstanceFull.identifiers
** Type: object
* refactoredNodes.objInstanceFull.fields
** Type: object
* refactoredNodes.versionDataSystemFields
** Type: object
* refactoredNodes.versionDataSystemFields.versionedDataLabel
** Type: object
* queryResult.requestParam
** Type: object
** Description: return example send param
* errorsFound
** Type: string
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
refactoredNodes: {
objTypes: [
{
serviceTag: "string",
objectType: "string",
}
],
objInstanceFull: {
identifiers: {
//… identifier
},
fields: {
//…fields
}
},
versionDataSystemFields: {
versionedDataLabel: {
originTimestamp: number,
forMatchedId: "string",
versionedDataId: "string"
}
}
}
},
requestParam: {
// return example send param
}
},
errorsFound: [],
graphServiceTag: ''
}
</syntaxhighlight>

== GetNodes ==
'''Use Case of GetNodes''' >>> https://izara.io/wiki/index.php/2025-04-23_Graph_Use_Case/GetNode_and_GetNodes#Use_Case_GetNodes
=== Request Parameters ===
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* fields
** Type : object
** Required: true
* versionedDataLabels
** Type: Array
** Required : optional
* settings.returnSystemFieldsName
** Type: Boolean
** Required : optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":string,
"objectType":string
},
"fields":{
//…fields with matching value
},
"versionedDataLabels":[
//…versionedDataLabels
],
"settings":{
"returnSystemFieldsName":boolean // default=false
},
"parentFlowId" :"" // optional
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResults
** Type: object
* queryResults.getNodesReturnValues
** Type: array
* getNodesReturnValues.objTypes
** Type: array
* getNodesReturnValues.objInstanceFull
** Type: object
* getNodesReturnValues.objInstanceFull.identifiers
** Type: object
* getNodesReturnValues.objInstanceFull.fields
** Type: object
* getNodesReturnValues.versionDataSystemFields
** Type: object
* getNodesReturnValues.versionDataSystemFields.versionedDataLabel
** Type: object
* requestParams
** Type: object
* errorsFound
** Type: string
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: {
getNodesReturnValues: [
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//.. all fields-1
}
},
versionDataSystemFields: {}
},
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//...all fields-2
}
},
versionDataSystemFields: {
versionedDataLabel: {
originTimestamp: number,
forMatchedId: 'string',
versionedDataId: 'string'
}
}
}
]
},
requestParams: {
// return example send param
}
}
}
</syntaxhighlight>

== UpdateNode ==
''' Use Case of UpdateNode''' >>> https://izara.io/wiki/index.php/2025-08-03_-_Graph_Use_Case/UpdateNode
=== 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: object
** Required : true
* objInstanceFull.fields
** Type : object
** Required: true
** Description : can not send fields to update mainNode and versionedData together
* versionedDataIds
** Type: object
** Required: optional
* originTimestamp
** Type: number
** Required: true
* settings
** Type: object
** Required: optional
* parentFlowId
** type : string
** Required: true
* callingFlow
** Type: string
** Required: optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType": {
"serviceTag": string,
"objectType": string
},
"objInstanceFull": {
"identifiers": {
//…identifiers
},
"fields": {
//…fields
// can not be send fields of mainNode and versionedData in fields together!
}
},
"versionedDataIds": {},
"originTimestamp": number, //// timestamp when update
"settings": {},
"parentFlowId": ""// required
"callingFlow": string
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* returnValue.queryResult
** Type: object
** Description: data from created node
* queryResult.objTypes
** Type: array
** Description: serviceTag and objectType
* queryResult.objInstanceFull
** Type: object
** Description: identifiers and fields
* queryResult.userId
** Type: object
** Description: data that update from user Account
* queryResult.versionDataSystemFields
** Type: object
** Description: optional return versionedData
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* returnValue.Status
** Type: string
** Description: status from updated node // error or complete
* returnValue.errorsFound
** Type: array
* returnValue.graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifiers
},
fields: {
//...fields
}
},
userId: {
// if have userNode send to updated
},
versionDataSystemFields: {
versionedDataLabel: {
}
}
},
requestParams: {
// return example send param
},
parentFlowId:""
},
status: 'string',//"complete" // "error"
errorsFound: [],
graphServiceTag: 'string'
}
</syntaxhighlight>

== CreateRelationship ==
''' Use Case of CreateRelationship''' >>> https://izara.io/wiki/index.php/2025-08-01_-_Graph_Use_Case/CreateRelationship
=== Request Parameters ===
* firstObject
** Type: object
** Required: true
* secondObject
** Type: object
** Required: true
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* identifiers
** Type: object
** Required : true
* additionalRelationships
** Type: array of object
** Required: optional
* relType
** Type: object
** Required: true
* relationshipDirection
** Type: string
** Required: true
* relationshipProperties
** Type: object
** Required: true
* deepPathConditional
** Type : array
** Required: optional
** Description : using deepPathConditional for check relationship if not exist , can check on firstNode and seconNode or additionalRelationships
* Settings
** Type: object
** Required: true
* settings.updateRelPropsWhenExist
** Type: boolean
** Required: optional
* parentFlowId
** type : string
** Required: true
* callingFlow
** Type: string
** Required: optional
* callingFlowConfig
** Type: object
** Required: optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject": {
"objType": {
"serviceTag": string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"additionalRelationships": [
{
"objType": {
"serviceTag":string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"relType": {
"serviceTag":string,
"relationshipTag":string
},
"relationshipProperties": {
//…properties
},
"relationshipDirection":string ,// “from” , “to”
"deepPathConditional": []
}
]
},
"secondObject": {
"objType": {
"serviceTag":string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"additionalRelationships": [
//…optional
]
},
"relType": {
"serviceTag":string,
"relationshipTag":string
},
"relationshipDirection":string, // “from” , “to”
"relationshipProperties": {
//…properties
},
"deepPathConditional": [ // default []
{
condition: 'notExist',
conditionCheck: {
nodeStructure: {
objType: {

},
fields: { }
},
nextPath: {
relationshipStructure: {
relType: {

},
relationshipDirection: ''
},
nodeStructure: {
objType: {

},
fields: { }
}
}
}
}
]
"settings": {
"reateOnConditionalFail": false // true default = false
"updateRelPropsWhenExist": boolean,
},
"parentFlowId": "", // required
"callingFlow": "xxxx",
"callingFlowProperties": {
"graphServiceName": string
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.relationship
** Type: object
* queryResult.relationship.relType
** Type: object
* queryResult.relationship.relationshipProperties
** Type: object
* queryResult.firstNode
** Type: object
** Description: return data structure from firstNode
* queryResult.secondNode
** Type: object
** Description: return data structure from secondNode
* queryResult..onCreateAddRelationships
** Type: array
** Description: return data structure from onCreateAddRelationships
* returnValue.firstObject
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* Status
** Type: string
** Description: status from create node // error or complete
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
relationship: {
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//…properties
}
},
firstNode: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: { //… identifiers },
fields: {
//… all fields
}
},
onCreateAddRelationships: [
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//… identifiers
},
fields: {
//… all fields
}
},
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//… all properties
}
}
]
},
secondNode: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: { //… identifiers },
fields: {
//… all fields
}
},
onCreateAddRelationships: [
//… optional
]
}
}
}
}
requestParams: {
// return example send param

},
parentFlowId: "",
Status: 'string', //“complete” // “error”
errorsFound: []
}
}
</syntaxhighlight>

== GetRelationship ==
=== Request Parameters ===
* firstObject
** Type: object
** Required: optional
* secondObject
** Type: object
** Required: optional
* objType
** Type: object
** Required: true
** Description: has serviceTag and objectType
* identifiers
** Type: object
** Required: true
* relType
** Type: object
** Required: true
** Description: has relationshipTag and serviceTag
* relId
** Type: string
** Required: true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag":string,
"objectType":string
},
"identifiers":{
//…identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"relType":{ // required
"relationshipTag": string,
"serviceTag": string
},
"relId": 'string' // // required,
"parentFlowId": "" // optional
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
* Type: object
* queryResult.relType
** Type: object
* queryResult.relationshipProperties
** Type: object
** Description: return relId and properties
* returnValue.toObject
** Type: object
** Description: return toObject if not send secondObject from param
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* errorsFound
** Type: array
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: {
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//…properties : 'string’
}
},
toObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: {
identifiers: {
//
},
fields: { }
}
},
requestParams: {
// return example send param
}
}
}

</syntaxhighlight>

== UpdateRelationship ==
=== Request Parameters ===
* firstObject
** Type: object
** Required: optional
* secondObject
** Type: object
** Required: Optional
* objType
** Type: object
** Required: true
** Description: has serviceTag and objectType
* identifiers
** Type: object
** Required: true
* relId
** Type: string
** Required: true
* relType
** Type: object
** Required: true
** Description: has relationshipTag and serviceTag
* relationshipProperties
** Type: object
** Required: true
** Description: send properties that want to update
* relationshipDirection
** Type: string
** Required: optional
* parentFlowId
** Type : string
** Required : true
* callingFlow
** Type: string
** Required: optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"relId": string,
"relType":{
"serviceTag":string,
"relationshipTag":string
},
"relationshipProperties":{
//… properties that want to update
},
"relationshipDirection": string, // "from" // “to”
"parentFlowId": ""// required
"callingFlow": string
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.firstObject And secondObject
** Type: object
** Description : return objType {seviceTag and objectType} And identifiers
* queryResult.relId
** Type: string
* queryResult.relType
** Type: object
** Description: return {seviceTag and relationshipTag}
* queryResult.relationshipDirection
** Type: string
* queryResult.updatePropertiesParam
** Type: object
** Description: return properties to updated
* queryResult.oldRelationshipProperties
** Type: object
** Description: return old properties before update
* queryResult.newRelationshipProperties
** Type: object
** Description: return new properties after updated
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type : string
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
firstObject: {
objType: {
serviceTag: "string",
objectType: "string"
},
identifiers: {
//…identifiers
}
},
secondObject: {
objType: {
serviceTag: "string",
objectType: "string"
},
identifiers: {
//…identifiers
}
},
relId: "string",
relType: {
serviceTag: "string",
relationshipTag: "string"
},
relationshipDirection: "string",
updatePropertiesParam: {
//… properties updated
},
oldRelationshipProperties: {
// … old properties before update
},
newRelationshipProperties: {
//… new properties after updated
}
}
},
requestParams: {
// return example send param
},
parentFlowId:"",
status: “string”, // "complete",”error”
errorsFound: []
}
</syntaxhighlight>

== GetNodeAndRelationship ==
=== Request Parameters ===
* sourceObjType
** Required: true
** Description: has serviceTag and objectType
* sourceIdentifiers
** Type: object
** Required: true
* sourceVersionedDataLabels
** Type: object
** Required: optional
* targetRelationships
** Type: Array
** Required: true
* relTypeAndDirection
** Type: object
** Required: true
* relTypeAndDirection.relType
** Type: object
** Required: true
** Description: has serviceTag and relationshipTag
* relTypeAndDirection.relationshipProperties
** Type: object
** Required: optional
* relTypeAndDirection.relationshipDirection
** Type: String
** Required: optional
* targetObjects
** Type: Array
** Required: Optional
* targetObjects.objType
** Type: object
** Required: required if send targetObjects in param
* targetObjects.identifiers
** Type: object
** Required: optional should have objType if identifiers exists
* targetObjects.versionedDataLabels
** Type: object
** Required: optional have objType if versionedDataLabels exists

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"sourceObjType": { // required
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"sourceIdentifiers": {}, // required
"sourceVersionedDataLabels": [], // optional
"targetRelationships": [ //required
{
"relTypeAndDirection": { // required
"relType": {
"serviceTag": "xxxx",
"relationshipTag": "rel"
},
"relationshipProperties": {},//optional
"relationshipDirection": "" // required
},
"targetObjects": [ // optional
{
"objType": {
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"identifiers": {}, // optional
"versionedDataLabels": [] // optional have objType if versionedDataLabels exists
}
]
},
// if have multiple relTypeAndDirection
],
"settings": {} // defaulf = false >>> if have versionedDataLabels want to return all field of versionedata: settings = { returnSystemFieldsName: true }
"parentFlowId": "" // optional
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.objTypes
** Type: array of object
** Description: return {serviceTag and objectType}
* queryResult.objInstanceFull
** Type: object
** Description: return {identifiers and fields}
* queryResult.relNodes:
** Type: array
* relNodes.relType
** Type: object
** Description: return {serviceTag and relationshipTag}
* relNodes.relationshipProperties
** Type: object
* relNodes.objTypes
** Type: array of object
** Description: return {serviceTag and objectType}
* relNodes.objInstanceFull
** Type: object
** Description: return {identifiers and fields}
* requestParams
** Type: object
** Description: return same requestParams
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: {},
fields: { }
},
relNodes: [
{
relType: {
serviceTag: 'xxxx',
relationshipTag: 'rel'
},
relationshipProperties: { },
objTypes: [
{
serviceTag: 'xxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: {},
fields: {
// field
}
},
versionDataSystemFields: {
'0VersionDataLabel': {
originTimestamp:
forMatchedId:
versionedDataId:
}
}
}
]
}
},
requestParam : {
// return example send param
},
errorsFound: [],
graphServiceTag: "GraphHandler"
}

</syntaxhighlight>

== ChangeRelationshipType ==
=== Request Parameters ===
* firstObject
** Type : object
** Required : true
* secondObject
** Type : object
** Required : true
* objType
** Type : object
** Required : true
* Identifiers
** Type : object
** Required : true
* oldRelTypeAndDirection
** Type : object
** Required : true
* oldRelTypeAndDirection.relType
** Type : object
** Required : true
* oldRelTypeAndDirection.relationshipDirection
** Type : string
** Required : true
* oldRelTypeAndDirection.relationshipProperties
** Type : object
** Required : optional
* newRelType
** Type : object
** Required : true
* originTimestamp
** Type : number
** Required : true
* changedByUserId
** Type : String
** Required : true
* callingFlow
** Type : String
** Required : optional
* settings
** Type : object
** Required : optional
** Description : default > settings.changeMultipleRelationships : false // if send settings.changeMultipleRelationships : true >> can change multiple relType

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"secondObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"oldRelTypeAndDirection":{
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"old"
},
"relationshipDirection":"from",
"relationshipProperties":{
//Properties
}
},
"newRelType":{
"serviceTag":"xxxx",
"relationshipTag":"new"
},
"originTimestamp":1234567890,
"changedByUserId":"xxxx",
"callingFlow":"yyyy",
"settings":{
"changeMultipleRelationships": boolean: // default false
}
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.newRelationshipType
** Type: object
* newRelationshipType.relType
** Type: object
* newRelationshipType.relationshipDirection
** Type: string
* newRelationshipType.relationshipProperties
** Type: object
* queryResult.oldRelationshipType
** Type: object
* oldRelationshipType.relType
** Type: object
* oldRelationshipType.relationshipDirection
** Type: string
* oldRelationshipType.relationshipProperties
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
newRelationshipType: {
relType: {
serviceTag: "xxxx",
relationshipTag: "new"
},
relationshipDirection: "" // 'from' or 'to'
relationshipProperties: {}
},
oldRelationshipType: {
relType: {
serviceTag: "xxxx",
relationshipTag: "old"
},
relationshipDirection: "" // 'from' or 'to'
relationshipProperties: {}
}
},
requestParams : {
// return example send param
}
},
status: "complete" // or error,
errorsFound: [],
graphServiceTag : 'GraphHandeler'
}

</syntaxhighlight>

== DeleteRelationship ==
=== Request Parameters ===
* fromObject
** Type : object
** Required : optional
* secondObject
** Type : object
** Required : optional
* objType
** Type : object
** Required : true
* Identifiers
** Type : object
** Required : true
* relType
** Type : object
** Required : true
* relId
** Type: string
** Required : true
* relationshipDirection
** Type: string
** Required : optional
* callingFlow
** Type: string
** Required : true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"yyyy"
},
"relId":"string"
},
"relationshipDirection":"string"// "from" or "to"
"callingFlow":"string"
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.objects
** Type: array
* queryResult.objTypes
** Type: array
* queryResult.objInstanceFull.identifiers
** Type: object
* queryResult.objInstanceFull.fields
** Type: object
** Description: return data of fromObject and secondObject
* queryResult.userNode
** Type: object
** Description: return data of userNode
* queryResult.resultDeleteRel
** Type : string
** Description: return status Relationship Delete
* requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objects: [
{
objTypes: [
{
serviceTag: "xxxx",
objectType: "yyyy"
}
],
objInstanceFull: {
identifiers: {
// identifiers
},
fields: {
// fields
}
}
},
{
// if have multiple object objTypes
}
],
userNode: {
objTypes: [
{
serviceTag: "UserAccount",
objectType: "user"
}
],
objInstanceFull: {
identifiers: {
userId: "zzz"
}
}
},
resultDeleteRel: "Relationship Deleted" // default
},
requeatParam: {
// return example send param
},
status: "string", //default "complete" or "error"
errorsFound: []
}
}

</syntaxhighlight>

== DeleteNode ==
=== Request Parameters ===
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* identifiers
** Type : object
** Required: true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":"xxx",
"objectType":"yyy"
},
"identifiers":{
//
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResults
** Type: object
* queryResults.resultDeleteNode
** Type: Boolean
** Description: return status deleted node >> true or false
* requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
** Description: return status deleted node >> complete or error
* errorsFound
** Type: array
* graphServiceTag
** Type: string
=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: { resultDeleteNode: true }, // true or false
requestParams: {
// return example send param
}
},
status: 'string', // 'complete' or 'error'
errorsFound: [],
graphServiceTag: 'GraphHandler'
}
</syntaxhighlight>

== MoveRelationship ==

=== Request Parameters ===
* sourceObject
** Type : object
** Required : true
** Description: required objType: {serviceTag , objectType} and identifiers
* targetObjType
** Type : object
** Required : true
** Description: required objType: {serviceTag , objectType}
* relType
** Type : object
** Required : true
** Description: required objType: {serviceTag , relationshipTag}
* relationshipDirection
** Type : object
** Required : true
* moveToIdentifiers
** Type : object
** Required : true
* moveByUserId
** Type : String
** Required : true
* originTimestamp
** Type : number
** Required : true
* settings
** Type : object
** Required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"sourceObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyy"
},
"identifiers":{
// identifiers
}
},
"targetObjType":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
}
},
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"rel"
},
"relationshipDirection":"from", // "to"
"moveToIdentifiers":{
// target identifiers
},
"moveByUserId":"xxxx",
"originTimestamp":1234567890,
"settings":{}
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.moveRelationship
** Type: object
* moveRelationship.sourceObject
** Type: object
** Description: return data of sourceObject
* moveRelationship.relationship
** Type: string
** Description: return data of after move relationship
* moveRelationship.moveToObject
** Type: object
** Description: return data of moveToObject
* moveRelationship.historyData
** Type: object
** Description: return properties {old target identifiers and originTimestamp} after moveRelationship
* moveRelationship.userNode
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
moveRelationship: {
sourceObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
}
},
relationship: {
relType: {
serviceTag: 'xxxx',
relationshipTag: 'rel'
},
relationshipProperties: { originTimestamp: 1234567890 }
},
moveToObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: { }
},
historyData: {
relationshipProperties: { }
},
userNode: {
objTypes: [{ serviceTag: 'UserAccount', objectType: 'user' }],
objInstanceFull: { }
}
}
},
requestParam: {
}
}
status: "complete" // or error,
errorsFound: [],
graphServiceTag: 'GraphHandler'
}

</syntaxhighlight>

== MoveNodeProperties ==
=== Request Parameters ===
* sourceObject
** type: object
** required : true
* targetIdentifiers
** type : object
** required : true
* moveProperties
** type : array
** required : true // index minimum = 1
* updateProperties
** type : object
** required : true
* movePropertiesConditions
** type : array
** required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
sourceObject: {
objType: { },
identifier: { }
},
targetIdentifiers: { },
moveProperties: [ ],
updateProperties: { },
movePropertiesConditions: [ // optional
{
checkObject: 'target', // "source" | "target"
onSetObject: 'target', // "source" | "target"
onPassValue: true,
onNotPassCondition: false, // optional
fieldNameConditions: [ ]
}
]
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.moveNodeProperties
** Type: object
* moveNodeProperties.sourceObject
** Type: object
** Description: return data of sourceObject
* moveRelationship.moveFieldToObject
** Type: string
** Description: return data after moveFieldToObject
* moveRelationship.movedFields
** Type: object
** Description: return data field of moveToObject
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String
=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
moveNodeProperties: {
sourceObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: {
identifiers: { },
fields: { }
}
},
moveFieldToObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: { },
fields: {

}
},
movedFields: { Fields: { } } //
}
}
},
requestParam: { },
status: 'complete',
errorsFound: [],
graphServiceTag: 'GraphHandler'
}
</syntaxhighlight>
[[Category:Working documents| 2025-03-06]]

2025-03-06 - Graph Handler Docs

2026-06-08T07:02:50Z

Seagame: /* Request Example */

= GraphHandler Function =
== CreateNode ==
'''Use Case of CreateNode''' >>> https://izara.io/wiki/index.php/2025-03-27_Graph_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
* setFieldConditionals
** type : array
** Required : optional
* deepPathConditional
** type : array
** Required : optional
* parentFlowId
** type : string
** Required: true
* callingFlowConfig
** Type: object
** Required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType": {
"objectType": string,
"serviceTag": string
},
"objInstanceFull": {
"identifiers": {
// ...identifier
},
"fields": {
// ...fields
}
},
setFieldConditionals: [ // optional default array
{
objType: { },
indexValue: { nameSpace: 'ex-011', systemTextTag: 'Gate-011' }, // index field : value
fieldName: '', // fieldName want to set
passValue: 'false', optional
notPassValue: 'true', //optional
conditionals: [ optional ] // condition check field
}
],
"relationships": [
{
"relType": {
"serviceTag": string,
"relationshipTag": string
},
"relationshipProperties": {
//... key and value of targetIdentifiers
},
"relationshipDirection": string, // "from" | "to"
"targetObjType": {
"serviceTag": string,
"objectType": string
},
"targetIdentifiers": {
//... targetIdentifiers
}
}
],
deepPathConditional: [ // optional default array
{
condition: 'notExist', //
conditionCheck: { // traversal
nodeStructure: {
objType: { },
fields: { }
},
nextPath: {
relationshipStructure: {
relType: { },
relationshipDirection: 'to'
},
nodeStructure: {
objType: { },
fields: { }
}
}
}
}
],
"originTimestamp": number, // timestamp when create
"settings": {
"updatePropertiesOnMatch": boolean // default=false
},
"parentFlowId": "", // required
"callingFlow": string,
"callingFlowProperties": object,
}
</syntaxhighlight>

=== 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.relationships
** Type: array
** Description: data from relationships in targetNode
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* Status
** Type: string
** Description: Status from create node. Return "error" or "complete".
* errorsFound
** Type: array
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">

{
returnValue: {
queryResult: {
returnCreateNode: {
objTypes: [
{
serviceTag: "string",
objectType: "string"
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//...fields
}
},
existsNode: { },
userNode: { // // if has userNode send to createNode
objTypes: [
{
"serviceTag": "UserAccount",
"objectType": "user"
}
],
properties: {
//...properties
}
},
relationships: [ // optional : if has requiredOnCreated , createNode with targetNode
{
objTypes: [
{ serviceTag: 'string', objectType: 'string' }
],
objInstanceFull: {
identifiers: {
// identifiers
}
},
relType: {
serviceTag: 'string',
relationshipTag: 'rel'
},
relationshipProperties: {
// properties
}
},
]
}
},
requestParams: {
// return example send param
},
parentFlowId:""
},
status: "string", // "complete' or "error"
errorsFound: [],
graphServiceTag: "GraphHandler"
}

</syntaxhighlight>

== GetNode ==
'''Use Case of GetNode''' >>> https://izara.io/wiki/index.php/2025-04-23_Graph_Use_Case/GetNode_and_GetNodes#Use_Case_GetNodes
=== 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
* versionedDataLabels
** Type: Array
** Required : optional
* settings.updatePropertiesOnMatch
** Type: Boolean
** Required : optional
* parentFlowId
** Type: string
** Required: optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":string,
"objectType":string
},
"objInstanceFull":{
"identifiers":{
// ...identifier
},
"fields":{
// ...fields
}
},
"versionedDataLabels":[
//…versionedData
],
"settings": {
"returnSystemFieldsName" :boolean // default = true or false
},
"parentFlowId" : "" // optional
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* returnValue.queryResult
** Type: object
* queryResult.refactoredNodes
** Type: object
** Description: return object from getNode
* refactoredNodes.objTypes
** Type: array
* refactoredNodes.objInstanceFull
** Type: object
* refactoredNodes.objInstanceFull.identifiers
** Type: object
* refactoredNodes.objInstanceFull.fields
** Type: object
* refactoredNodes.versionDataSystemFields
** Type: object
* refactoredNodes.versionDataSystemFields.versionedDataLabel
** Type: object
* queryResult.requestParam
** Type: object
** Description: return example send param
* errorsFound
** Type: string
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
refactoredNodes: {
objTypes: [
{
serviceTag: "string",
objectType: "string",
}
],
objInstanceFull: {
identifiers: {
//… identifier
},
fields: {
//…fields
}
},
versionDataSystemFields: {
versionedDataLabel: {
originTimestamp: number,
forMatchedId: "string",
versionedDataId: "string"
}
}
}
},
requestParam: {
// return example send param
}
},
errorsFound: [],
graphServiceTag: ''
}
</syntaxhighlight>

== GetNodes ==
'''Use Case of GetNodes''' >>> https://izara.io/wiki/index.php/2025-04-23_Graph_Use_Case/GetNode_and_GetNodes#Use_Case_GetNodes
=== Request Parameters ===
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* fields
** Type : object
** Required: true
* versionedDataLabels
** Type: Array
** Required : optional
* settings.returnSystemFieldsName
** Type: Boolean
** Required : optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":string,
"objectType":string
},
"fields":{
//…fields with matching value
},
"versionedDataLabels":[
//…versionedDataLabels
],
"settings":{
"returnSystemFieldsName":boolean // default=false
},
"parentFlowId" :"" // optional
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResults
** Type: object
* queryResults.getNodesReturnValues
** Type: array
* getNodesReturnValues.objTypes
** Type: array
* getNodesReturnValues.objInstanceFull
** Type: object
* getNodesReturnValues.objInstanceFull.identifiers
** Type: object
* getNodesReturnValues.objInstanceFull.fields
** Type: object
* getNodesReturnValues.versionDataSystemFields
** Type: object
* getNodesReturnValues.versionDataSystemFields.versionedDataLabel
** Type: object
* requestParams
** Type: object
* errorsFound
** Type: string
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: {
getNodesReturnValues: [
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//.. all fields-1
}
},
versionDataSystemFields: {}
},
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//...all fields-2
}
},
versionDataSystemFields: {
versionedDataLabel: {
originTimestamp: number,
forMatchedId: 'string',
versionedDataId: 'string'
}
}
}
]
},
requestParams: {
// return example send param
}
}
}
</syntaxhighlight>

== UpdateNode ==
''' Use Case of UpdateNode''' >>> https://izara.io/wiki/index.php/2025-08-03_-_Graph_Use_Case/UpdateNode
=== 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: object
** Required : true
* objInstanceFull.fields
** Type : object
** Required: true
** Description : can not send fields to update mainNode and versionedData together
* versionedDataIds
** Type: object
** Required: optional
* originTimestamp
** Type: number
** Required: true
* settings
** Type: object
** Required: optional
* parentFlowId
** type : string
** Required: true
* callingFlow
** Type: string
** Required: optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType": {
"serviceTag": string,
"objectType": string
},
"objInstanceFull": {
"identifiers": {
//…identifiers
},
"fields": {
//…fields
// can not be send fields of mainNode and versionedData in fields together!
}
},
"versionedDataIds": {},
"originTimestamp": number, //// timestamp when update
"settings": {},
"parentFlowId": ""// required
"callingFlow": string
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* returnValue.queryResult
** Type: object
** Description: data from created node
* queryResult.objTypes
** Type: array
** Description: serviceTag and objectType
* queryResult.objInstanceFull
** Type: object
** Description: identifiers and fields
* queryResult.userId
** Type: object
** Description: data that update from user Account
* queryResult.versionDataSystemFields
** Type: object
** Description: optional return versionedData
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* returnValue.Status
** Type: string
** Description: status from updated node // error or complete
* returnValue.errorsFound
** Type: array
* returnValue.graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifiers
},
fields: {
//...fields
}
},
userId: {
// if have userNode send to updated
},
versionDataSystemFields: {
versionedDataLabel: {
}
}
},
requestParams: {
// return example send param
},
parentFlowId:""
},
status: 'string',//"complete" // "error"
errorsFound: [],
graphServiceTag: 'string'
}
</syntaxhighlight>

== CreateRelationship ==
''' Use Case of CreateRelationship''' >>> https://izara.io/wiki/index.php/2025-08-01_-_Graph_Use_Case/CreateRelationship
=== Request Parameters ===
* firstObject
** Type: object
** Required: true
* secondObject
** Type: object
** Required: true
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* identifiers
** Type: object
** Required : true
* additionalRelationships
** Type: array of object
** Required: optional
* relType
** Type: object
** Required: true
* relationshipDirection
** Type: string
** Required: true
* relationshipProperties
** Type: object
** Required: true
* deepPathConditional
** Type : array
** Required: optional
** Description : using deepPathConditional for check relationship if not exist , can check on firstNode and seconNode or additionalRelationships
* Settings
** Type: object
** Required: true
* settings.updateRelPropsWhenExist
** Type: boolean
** Required: optional
* parentFlowId
** type : string
** Required: true
* callingFlow
** Type: string
** Required: optional
* callingFlowConfig
** Type: object
** Required: optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject": {
"objType": {
"serviceTag": string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"additionalRelationships": [
{
"objType": {
"serviceTag":string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"relType": {
"serviceTag":string,
"relationshipTag":string
},
"relationshipProperties": {
//…properties
},
"relationshipDirection":string ,// “from” , “to”
"deepPathConditional": []
}
]
},
"secondObject": {
"objType": {
"serviceTag":string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"additionalRelationships": [
//…optional
]
},
"relType": {
"serviceTag":string,
"relationshipTag":string
},
"relationshipDirection":string, // “from” , “to”
"relationshipProperties": {
//…properties
},
"deepPathConditional": [ // default []
{
condition: 'notExist',
conditionCheck: {
nodeStructure: {
objType: {

},
fields: { }
},
nextPath: {
relationshipStructure: {
relType: {

},
relationshipDirection: ''
},
nodeStructure: {
objType: {

},
fields: { }
}
}
}
}
]
"settings": {
"reateOnConditionalFail": false // true default = false
"updateRelPropsWhenExist": boolean,
},
"parentFlowId": "", // required
"callingFlow": "xxxx",
"callingFlowProperties": {
"graphServiceName": string
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.relationship
** Type: object
* queryResult.relationship.relType
** Type: object
* queryResult.relationship.relationshipProperties
** Type: object
* queryResult.firstNode
** Type: object
** Description: return data structure from firstNode
* queryResult.secondNode
** Type: object
** Description: return data structure from secondNode
* queryResult..onCreateAddRelationships
** Type: array
** Description: return data structure from onCreateAddRelationships
* returnValue.firstObject
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* Status
** Type: string
** Description: status from create node // error or complete
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
relationship: {
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//…properties
}
},
firstNode: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: { //… identifiers },
fields: {
//… all fields
}
},
onCreateAddRelationships: [
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//… identifiers
},
fields: {
//… all fields
}
},
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//… all properties
}
}
]
},
secondNode: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: { //… identifiers },
fields: {
//… all fields
}
},
onCreateAddRelationships: [
//… optional
]
}
}
}
}
requestParams: {
// return example send param

},
parentFlowId: "",
Status: 'string', //“complete” // “error”
errorsFound: []
}
}
</syntaxhighlight>

== GetRelationship ==
=== Request Parameters ===
* firstObject
** Type: object
** Required: optional
* secondObject
** Type: object
** Required: optional
* objType
** Type: object
** Required: true
** Description: has serviceTag and objectType
* identifiers
** Type: object
** Required: true
* relType
** Type: object
** Required: true
** Description: has relationshipTag and serviceTag
* relId
** Type: string
** Required: true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag":string,
"objectType":string
},
"identifiers":{
//…identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"relType":{ // required
"relationshipTag": string,
"serviceTag": string
},
"relId": 'string' // // required,
"parentFlowId": "" // optional
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
* Type: object
* queryResult.relType
** Type: object
* queryResult.relationshipProperties
** Type: object
** Description: return relId and properties
* returnValue.toObject
** Type: object
** Description: return toObject if not send secondObject from param
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* errorsFound
** Type: array
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: {
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//…properties : 'string’
}
},
toObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: {
identifiers: {
//
},
fields: { }
}
},
requestParams: {
// return example send param
}
}
}

</syntaxhighlight>

== UpdateRelationship ==
=== Request Parameters ===
* firstObject
** Type: object
** Required: optional
* secondObject
** Type: object
** Required: Optional
* objType
** Type: object
** Required: true
** Description: has serviceTag and objectType
* identifiers
** Type: object
** Required: true
* relId
** Type: string
** Required: true
* relType
** Type: object
** Required: true
** Description: has relationshipTag and serviceTag
* relationshipProperties
** Type: object
** Required: true
** Description: send properties that want to update
* relationshipDirection
** Type: string
** Required: optional
* parentFlowId
** Type : string
** Required : true
* callingFlow
** Type: string
** Required: optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"relId": string,
"relType":{
"serviceTag":string,
"relationshipTag":string
},
"relationshipProperties":{
//… properties that want to update
},
"relationshipDirection": string, // "from" // “to”
"parentFlowId": ""// required
"callingFlow": string
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.firstObject And secondObject
** Type: object
** Description : return objType {seviceTag and objectType} And identifiers
* queryResult.relId
** Type: string
* queryResult.relType
** Type: object
** Description: return {seviceTag and relationshipTag}
* queryResult.relationshipDirection
** Type: string
* queryResult.updatePropertiesParam
** Type: object
** Description: return properties to updated
* queryResult.oldRelationshipProperties
** Type: object
** Description: return old properties before update
* queryResult.newRelationshipProperties
** Type: object
** Description: return new properties after updated
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type : string
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
firstObject: {
objType: {
serviceTag: "string",
objectType: "string"
},
identifiers: {
//…identifiers
}
},
secondObject: {
objType: {
serviceTag: "string",
objectType: "string"
},
identifiers: {
//…identifiers
}
},
relId: "string",
relType: {
serviceTag: "string",
relationshipTag: "string"
},
relationshipDirection: "string",
updatePropertiesParam: {
//… properties updated
},
oldRelationshipProperties: {
// … old properties before update
},
newRelationshipProperties: {
//… new properties after updated
}
}
},
requestParams: {
// return example send param
},
parentFlowId:"",
status: “string”, // "complete",”error”
errorsFound: []
}
</syntaxhighlight>

== GetNodeAndRelationship ==
=== Request Parameters ===
* sourceObjType
** Required: true
** Description: has serviceTag and objectType
* sourceIdentifiers
** Type: object
** Required: true
* sourceVersionedDataLabels
** Type: object
** Required: optional
* targetRelationships
** Type: Array
** Required: true
* relTypeAndDirection
** Type: object
** Required: true
* relTypeAndDirection.relType
** Type: object
** Required: true
** Description: has serviceTag and relationshipTag
* relTypeAndDirection.relationshipProperties
** Type: object
** Required: optional
* relTypeAndDirection.relationshipDirection
** Type: String
** Required: optional
* targetObjects
** Type: Array
** Required: Optional
* targetObjects.objType
** Type: object
** Required: required if send targetObjects in param
* targetObjects.identifiers
** Type: object
** Required: optional should have objType if identifiers exists
* targetObjects.versionedDataLabels
** Type: object
** Required: optional have objType if versionedDataLabels exists

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"sourceObjType": { // required
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"sourceIdentifiers": {}, // required
"sourceVersionedDataLabels": [], // optional
"targetRelationships": [ //required
{
"relTypeAndDirection": { // required
"relType": {
"serviceTag": "xxxx",
"relationshipTag": "rel"
},
"relationshipProperties": {},//optional
"relationshipDirection": "" // required
},
"targetObjects": [ // optional
{
"objType": {
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"identifiers": {}, // optional
"versionedDataLabels": [] // optional have objType if versionedDataLabels exists
}
]
},
// if have multiple relTypeAndDirection
],
"settings": {} // defaulf = false >>> if have versionedDataLabels want to return all field of versionedata: settings = { returnSystemFieldsName: true }
"parentFlowId": "" // optional
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.objTypes
** Type: array of object
** Description: return {serviceTag and objectType}
* queryResult.objInstanceFull
** Type: object
** Description: return {identifiers and fields}
* queryResult.relNodes:
** Type: array
* relNodes.relType
** Type: object
** Description: return {serviceTag and relationshipTag}
* relNodes.relationshipProperties
** Type: object
* relNodes.objTypes
** Type: array of object
** Description: return {serviceTag and objectType}
* relNodes.objInstanceFull
** Type: object
** Description: return {identifiers and fields}
* requestParams
** Type: object
** Description: return same requestParams
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: {},
fields: { }
},
relNodes: [
{
relType: {
serviceTag: 'xxxx',
relationshipTag: 'rel'
},
relationshipProperties: { },
objTypes: [
{
serviceTag: 'xxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: {},
fields: {
// field
}
},
versionDataSystemFields: {
'0VersionDataLabel': {
originTimestamp:
forMatchedId:
versionedDataId:
}
}
}
]
}
},
requestParam : {
// return example send param
},
errorsFound: [],
graphServiceTag: "GraphHandler"
}

</syntaxhighlight>

== ChangeRelationshipType ==
=== Request Parameters ===
* firstObject
** Type : object
** Required : true
* secondObject
** Type : object
** Required : true
* objType
** Type : object
** Required : true
* Identifiers
** Type : object
** Required : true
* oldRelTypeAndDirection
** Type : object
** Required : true
* oldRelTypeAndDirection.relType
** Type : object
** Required : true
* oldRelTypeAndDirection.relationshipDirection
** Type : string
** Required : true
* oldRelTypeAndDirection.relationshipProperties
** Type : object
** Required : optional
* newRelType
** Type : object
** Required : true
* originTimestamp
** Type : number
** Required : true
* changedByUserId
** Type : String
** Required : true
* callingFlow
** Type : String
** Required : optional
* settings
** Type : object
** Required : optional
** Description : default > settings.changeMultipleRelationships : false // if send settings.changeMultipleRelationships : true >> can change multiple relType

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"secondObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"oldRelTypeAndDirection":{
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"old"
},
"relationshipDirection":"from",
"relationshipProperties":{
//Properties
}
},
"newRelType":{
"serviceTag":"xxxx",
"relationshipTag":"new"
},
"originTimestamp":1234567890,
"changedByUserId":"xxxx",
"callingFlow":"yyyy",
"settings":{
"changeMultipleRelationships": boolean: // default false
}
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.newRelationshipType
** Type: object
* newRelationshipType.relType
** Type: object
* newRelationshipType.relationshipDirection
** Type: string
* newRelationshipType.relationshipProperties
** Type: object
* queryResult.oldRelationshipType
** Type: object
* oldRelationshipType.relType
** Type: object
* oldRelationshipType.relationshipDirection
** Type: string
* oldRelationshipType.relationshipProperties
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
newRelationshipType: {
relType: {
serviceTag: "xxxx",
relationshipTag: "new"
},
relationshipDirection: "" // 'from' or 'to'
relationshipProperties: {}
},
oldRelationshipType: {
relType: {
serviceTag: "xxxx",
relationshipTag: "old"
},
relationshipDirection: "" // 'from' or 'to'
relationshipProperties: {}
}
},
requestParams : {
// return example send param
}
},
status: "complete" // or error,
errorsFound: [],
graphServiceTag : 'GraphHandeler'
}

</syntaxhighlight>

== DeleteRelationship ==
=== Request Parameters ===
* fromObject
** Type : object
** Required : optional
* secondObject
** Type : object
** Required : optional
* objType
** Type : object
** Required : true
* Identifiers
** Type : object
** Required : true
* relType
** Type : object
** Required : true
* relId
** Type: string
** Required : true
* relationshipDirection
** Type: string
** Required : optional
* callingFlow
** Type: string
** Required : true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"yyyy"
},
"relId":"string"
},
"relationshipDirection":"string"// "from" or "to"
"callingFlow":"string"
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.objects
** Type: array
* queryResult.objTypes
** Type: array
* queryResult.objInstanceFull.identifiers
** Type: object
* queryResult.objInstanceFull.fields
** Type: object
** Description: return data of fromObject and secondObject
* queryResult.userNode
** Type: object
** Description: return data of userNode
* queryResult.resultDeleteRel
** Type : string
** Description: return status Relationship Delete
* requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objects: [
{
objTypes: [
{
serviceTag: "xxxx",
objectType: "yyyy"
}
],
objInstanceFull: {
identifiers: {
// identifiers
},
fields: {
// fields
}
}
},
{
// if have multiple object objTypes
}
],
userNode: {
objTypes: [
{
serviceTag: "UserAccount",
objectType: "user"
}
],
objInstanceFull: {
identifiers: {
userId: "zzz"
}
}
},
resultDeleteRel: "Relationship Deleted" // default
},
requeatParam: {
// return example send param
},
status: "string", //default "complete" or "error"
errorsFound: []
}
}

</syntaxhighlight>

== DeleteNode ==
=== Request Parameters ===
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* identifiers
** Type : object
** Required: true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":"xxx",
"objectType":"yyy"
},
"identifiers":{
//
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResults
** Type: object
* queryResults.resultDeleteNode
** Type: Boolean
** Description: return status deleted node >> true or false
* requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
** Description: return status deleted node >> complete or error
* errorsFound
** Type: array
* graphServiceTag
** Type: string
=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: { resultDeleteNode: true }, // true or false
requestParams: {
// return example send param
}
},
status: 'string', // 'complete' or 'error'
errorsFound: [],
graphServiceTag: 'GraphHandler'
}
</syntaxhighlight>

== MoveRelationship ==

=== Request Parameters ===
* sourceObject
** Type : object
** Required : true
** Description: required objType: {serviceTag , objectType} and identifiers
* targetObjType
** Type : object
** Required : true
** Description: required objType: {serviceTag , objectType}
* relType
** Type : object
** Required : true
** Description: required objType: {serviceTag , relationshipTag}
* relationshipDirection
** Type : object
** Required : true
* moveToIdentifiers
** Type : object
** Required : true
* moveByUserId
** Type : String
** Required : true
* originTimestamp
** Type : number
** Required : true
* settings
** Type : object
** Required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"sourceObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyy"
},
"identifiers":{
// identifiers
}
},
"targetObjType":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
}
},
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"rel"
},
"relationshipDirection":"from", // "to"
"moveToIdentifiers":{
// target identifiers
},
"moveByUserId":"xxxx",
"originTimestamp":1234567890,
"settings":{}
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.moveRelationship
** Type: object
* moveRelationship.sourceObject
** Type: object
** Description: return data of sourceObject
* moveRelationship.relationship
** Type: string
** Description: return data of after move relationship
* moveRelationship.moveToObject
** Type: object
** Description: return data of moveToObject
* moveRelationship.historyData
** Type: object
** Description: return properties {old target identifiers and originTimestamp} after moveRelationship
* moveRelationship.userNode
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
moveRelationship: {
sourceObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
}
},
relationship: {
relType: {
serviceTag: 'xxxx',
relationshipTag: 'rel'
},
relationshipProperties: { originTimestamp: 1234567890 }
},
moveToObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: { }
},
historyData: {
relationshipProperties: { }
},
userNode: {
objTypes: [{ serviceTag: 'UserAccount', objectType: 'user' }],
objInstanceFull: { }
}
}
},
requestParam: {
}
}
status: "complete" // or error,
errorsFound: [],
graphServiceTag: 'GraphHandler'
}

</syntaxhighlight>

== MoveNodeProperties ==
=== Request Parameters ===
* sourceObject
** type: object
** required : true
* targetIdentifiers
** type : object
** required : true
* moveProperties
** type : array
** required : true // index minimum = 1
* updateProperties
** type : object
** required : true
* movePropertiesConditions
** type : array
** required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
sourceObject: {
objType: { },
identifier: { }
},
targetIdentifiers: { },
moveProperties: [ ],
updateProperties: { },
movePropertiesConditions: [ // optional
{
checkObject: 'target', // "source" | "target"
onSetObject: 'target', // "source" | "target"
onPassValue: true,
onNotPassCondition: false, // optional
fieldNameConditions: [ ]
}
]
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.moveNodeProperties
** Type: object
* moveNodeProperties.sourceObject
** Type: object
** Description: return data of sourceObject
* moveRelationship.moveFieldToObject
** Type: string
** Description: return data after moveFieldToObject
* moveRelationship.movedFields
** Type: object
** Description: return data field of moveToObject
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String
=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
moveNodeProperties: {
sourceObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: {
identifiers: { },
fields: { }
}
},
moveFieldToObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: { },
fields: {

}
},
movedFields: { Fields: { } } //
}
}
},
requestParam: { },
status: 'complete',
errorsFound: [],
graphServiceTag: 'GraphHandler'
}
</syntaxhighlight>
[[Category:Working documents| 2025-03-06]]

Service - Unit Type

2026-06-08T04:15:01Z

Seagame: /* relationshipSchemas */

= Overview =

Each unitStandard is connected to a unitType which defines unitTrackedPropertys and how to handle them. unitPacking probably also uses the unitType structure.

= Repository =

https://bitbucket.org/izara-supply-units/izara-supply-units-unit-type

= Unit Type configuration =

unitType settings cannot be changed once created, so if want to adjust them would need to create a new unitType, this is because too much logic and data for unitStandard instances rely on unitType settings, data could break if settings changed.

= objectSchemas =

<syntaxhighlight lang="JavaScript">
{
objectType: "unitType",
belongTo: {
serviceTag:"SupplyNetwork",
objectType:"supplyNetwork"
},
storageResources:{
"xxx":{
storageType: "graph",
graphServerTag: "xx",
}
},
addOnDataStructure: [
{
type:"translation"
}
],
fieldNames: {
unitTypeId: {
type: "string",
randomOnCreate: true
},
},
identifiers: [
{
fieldName: "unitTypeId"
},
]
},
</syntaxhighlight>

<syntaxhighlight lang="JavaScript">
{
objectType: "unitTypeTrackedProperty",
belongTo: { // maybe in future when add RBAC to unitType
serviceTag:"SupplyNetwork",
objectType:"supplyNetwork"
},
storageResources:{
"xxx":{
storageType: "graph",
graphServerTag: "xx",
}
},
fieldNames: {
unitTypeTrackedPropertyId: {
type: "string",
randomOnCreate: true
},
precision: { // sets whether decimals are allowed and precision level
type: "integer" ,
requiredOnCreate: true,
},
canNegative: { // default false, sets whether only zero and positive values are allowed
type: "boolean" ,
requiredOnCreate: true,
},
inactiveIfZero: { // default false, if value of this property goes to zero automatically removes activeUnit relationship and adds inactiveUnit relationship
type: "boolean" ,
requiredOnCreate: true,
},
isCurrency: { // default false, sets whether unitTrackedProperty value is a currency amount
type: "boolean" ,
requiredOnCreate: true,
},
},
identifiers: [
{
fieldName: "unitTypeTrackedPropertyId"
},
]
},
</syntaxhighlight>

* currency is handled special because conversions can be performed
* multiple unitType instances can link to the same unitTypeTrackedProperty
* examples: yards, weight, cost (see calculatedProperties in [[Service - Transform Units]])

<syntaxhighlight lang="JavaScript">
{
objectType: "unitTrackedProperty",
belongTo: { // in future add RBAC to eg Units
serviceTag:"SupplyNetwork",
objectType:"supplyNetwork"
},
storageResources:{
"xxx":{
storageType: "graph",
graphServerTag: "xx",
}
},
fieldNames: {
unitTrackedPropertyId: {
type: "string",
randomOnCreate: true
},
propertyValue: {
type: "string", // so can adjust any type of property, will need cast type in logic
requiredOnCreate: true,
canUpdate: true,
},
},
identifiers: [
{
fieldName: "unitTrackedPropertyId"
},
]
},
</syntaxhighlight>

* each unit instance has unitTrackedProperty's for each of it's unitType's unitTypeTrackedPropertys
* unitTrackedProperty holds the value for eacn unitTypeTrackedProperty for a unit

= relationshipSchemas =

<syntaxhighlight lang="JavaScript">
[
{
"isUnitType": {
storageResources:{
"xxx":{
storageType: "graph",
graphServerTag: "xx",
}
},
links: [
{
storageResourceTags: ["xxx"],
canDelete: false,
from: {
objType: {
serviceTag: "unitManager",
objectType: "unit"
},
linkType: "many",
},
to: {
objType: {
serviceTag: "unitType",
objectType: "unitType"
},
linkType: "one",
}
}
]
}
}
]
</syntaxhighlight>

<syntaxhighlight lang="JavaScript">
[
{
"hasUnitTypeTrackedProperty": {
storageResources:{
"xxx":{
storageType: "graph",
graphServerTag: "xx",
}
},
fieldNames: {
"defaultValue": {
type: "string",
requiredOnCreate: true,
}
},
links: [
{
storageResourceTags: ["xxx"],
canDelete: false,
from: {
objType: {
serviceTag: "unitType",
objectType: "unitType"
},
linkType: "many",
},
to: {
objType: {
serviceTag: "unitType",
objectType: "unitTypeTrackedProperty"
},
linkType: "many",
}
}
]
}
}
]
</syntaxhighlight>

* sets which unitTypeTrackedProperty unitType has

<syntaxhighlight lang="JavaScript">
[
{
"isUnitTypeTrackedProperty": {
storageResources:{
"xxx":{
storageType: "graph",
graphServerTag: "xx",
}
},
links: [
{
storageResourceTags: ["xxx"],
canDelete: false,
from: {
objType: {
serviceTag: "unitType",
objectType: "unitTrackedProperty"
},
linkType: "many",
},
to: {
objType: {
serviceTag: "unitType",
objectType: "unitTypeTrackedProperty"
},
linkType: "many",
}
}
]
}
}
]
</syntaxhighlight>

* links each unitTrackedProperty to it's matching unitTypeTrackedProperty

<syntaxhighlight lang="JavaScript">
[
{
"hasUnitTrackedProperty": {
storageResources:{
"xxx":{
storageType: "graph",
graphServerTag: "xx",
}
},
links: [
{
storageResourceTags: ["xxx"],
canDelete: true,
from: {
objType: {
serviceTag: "unitManager",
objectType: "unit"
},
linkType: "one",
},
to: {
objType: {
serviceTag: "unitType",
objectType: "unitTrackedProperty"
},
linkType: "many",
}
}
]
}
}
]
</syntaxhighlight>

* Units current unitTrackedProperty for each unitTypeTrackedProperty

<syntaxhighlight lang="JavaScript">
[
{
"oldUnitTrackedProperty": {
storageResources:{
"xxx":{
storageType: "graph",
graphServerTag: "xx",
}
},
fieldNames: {
"fromTimestamp": {
type: "timestamp",
requiredOnCreate: true,
},
"toTimestamp": {
type: "timestamp",
requiredOnCreate: true,
}
},
links: [
{
storageResourceTags: ["xxx"],
canDelete: true,
from: {
objType: {
serviceTag: "unitManager",
objectType: "unit"
},
linkType: "one",
},
to: {
objType: {
serviceTag: "unitType",
objectType: "unitTrackedProperty"
},
linkType: "many",
}
}
]
}
}
]
</syntaxhighlight>

* old unitTrackedProperties for a unit, maintains a history of unitTrackedProperty propertyValue changes
* when a change is made to a unitTrackedProperty propertyValue a new unitTrackedProperty is created and hasUnitTrackedProperty links to unitStandard, while old hasUnitTrackedProperty relationship is removed and replaced with a oldUnitTrackedProperty

= Working documents =

[[:Category:Working_documents - Unit Type|Unit Type]]

[[Category:Backend services| Unit Type]]

Service - Unit Type

2026-06-08T04:09:33Z

Seagame: /* relationshipSchemas */

= Overview =

Each unitStandard is connected to a unitType which defines unitTrackedPropertys and how to handle them. unitPacking probably also uses the unitType structure.

= Repository =

https://bitbucket.org/izara-supply-units/izara-supply-units-unit-type

= Unit Type configuration =

unitType settings cannot be changed once created, so if want to adjust them would need to create a new unitType, this is because too much logic and data for unitStandard instances rely on unitType settings, data could break if settings changed.

= objectSchemas =

<syntaxhighlight lang="JavaScript">
{
objectType: "unitType",
belongTo: {
serviceTag:"SupplyNetwork",
objectType:"supplyNetwork"
},
storageResources:{
"xxx":{
storageType: "graph",
graphServerTag: "xx",
}
},
addOnDataStructure: [
{
type:"translation"
}
],
fieldNames: {
unitTypeId: {
type: "string",
randomOnCreate: true
},
},
identifiers: [
{
fieldName: "unitTypeId"
},
]
},
</syntaxhighlight>

<syntaxhighlight lang="JavaScript">
{
objectType: "unitTypeTrackedProperty",
belongTo: { // maybe in future when add RBAC to unitType
serviceTag:"SupplyNetwork",
objectType:"supplyNetwork"
},
storageResources:{
"xxx":{
storageType: "graph",
graphServerTag: "xx",
}
},
fieldNames: {
unitTypeTrackedPropertyId: {
type: "string",
randomOnCreate: true
},
precision: { // sets whether decimals are allowed and precision level
type: "integer" ,
requiredOnCreate: true,
},
canNegative: { // default false, sets whether only zero and positive values are allowed
type: "boolean" ,
requiredOnCreate: true,
},
inactiveIfZero: { // default false, if value of this property goes to zero automatically removes activeUnit relationship and adds inactiveUnit relationship
type: "boolean" ,
requiredOnCreate: true,
},
isCurrency: { // default false, sets whether unitTrackedProperty value is a currency amount
type: "boolean" ,
requiredOnCreate: true,
},
},
identifiers: [
{
fieldName: "unitTypeTrackedPropertyId"
},
]
},
</syntaxhighlight>

* currency is handled special because conversions can be performed
* multiple unitType instances can link to the same unitTypeTrackedProperty
* examples: yards, weight, cost (see calculatedProperties in [[Service - Transform Units]])

<syntaxhighlight lang="JavaScript">
{
objectType: "unitTrackedProperty",
belongTo: { // in future add RBAC to eg Units
serviceTag:"SupplyNetwork",
objectType:"supplyNetwork"
},
storageResources:{
"xxx":{
storageType: "graph",
graphServerTag: "xx",
}
},
fieldNames: {
unitTrackedPropertyId: {
type: "string",
randomOnCreate: true
},
propertyValue: {
type: "string", // so can adjust any type of property, will need cast type in logic
requiredOnCreate: true,
canUpdate: true,
},
},
identifiers: [
{
fieldName: "unitTrackedPropertyId"
},
]
},
</syntaxhighlight>

* each unit instance has unitTrackedProperty's for each of it's unitType's unitTypeTrackedPropertys
* unitTrackedProperty holds the value for eacn unitTypeTrackedProperty for a unit

= relationshipSchemas =

<syntaxhighlight lang="JavaScript">
[
{
"isUnitType": {
storageResources:{
"xxx":{
storageType: "graph",
graphServerTag: "xx",
}
},
links: [
{
storageResourceTags: ["xxx"],
canDelete: false,
from: {
objType: {
serviceTag: "unitManager",
objectType: "unit"
},
linkType: "many",
},
to: {
objType: {
serviceTag: "unitType",
objectType: "unitType"
},
linkType: "one",
}
}
]
}
}
]
</syntaxhighlight>

<syntaxhighlight lang="JavaScript">
[
{
"hasUnitTypeTrackedProperty": {
storageResources:{
"xxx":{
storageType: "graph",
graphServerTag: "xx",
}
},
fieldNames: {
"defaultValue": {
type: "string",
requiredOnCreate: true,
}
},
links: [
{
storageResourceTags: ["xxx"],
canDelete: false,
from: {
objType: {
serviceTag: "unitType",
objectType: "unitType"
},
linkType: "many",
},
to: {
objType: {
serviceTag: "unitType",
objectType: "unitTypeTrackedProperty"
},
linkType: "one",
}
}
]
}
}
]
</syntaxhighlight>

* sets which unitTypeTrackedProperty unitType has

<syntaxhighlight lang="JavaScript">
[
{
"isUnitTypeTrackedProperty": {
storageResources:{
"xxx":{
storageType: "graph",
graphServerTag: "xx",
}
},
links: [
{
storageResourceTags: ["xxx"],
canDelete: false,
from: {
objType: {
serviceTag: "unitType",
objectType: "unitTrackedProperty"
},
linkType: "many",
},
to: {
objType: {
serviceTag: "unitType",
objectType: "unitTypeTrackedProperty"
},
linkType: "many",
}
}
]
}
}
]
</syntaxhighlight>

* links each unitTrackedProperty to it's matching unitTypeTrackedProperty

<syntaxhighlight lang="JavaScript">
[
{
"hasUnitTrackedProperty": {
storageResources:{
"xxx":{
storageType: "graph",
graphServerTag: "xx",
}
},
links: [
{
storageResourceTags: ["xxx"],
canDelete: true,
from: {
objType: {
serviceTag: "unitManager",
objectType: "unit"
},
linkType: "one",
},
to: {
objType: {
serviceTag: "unitType",
objectType: "unitTrackedProperty"
},
linkType: "many",
}
}
]
}
}
]
</syntaxhighlight>

* Units current unitTrackedProperty for each unitTypeTrackedProperty

<syntaxhighlight lang="JavaScript">
[
{
"oldUnitTrackedProperty": {
storageResources:{
"xxx":{
storageType: "graph",
graphServerTag: "xx",
}
},
fieldNames: {
"fromTimestamp": {
type: "timestamp",
requiredOnCreate: true,
},
"toTimestamp": {
type: "timestamp",
requiredOnCreate: true,
}
},
links: [
{
storageResourceTags: ["xxx"],
canDelete: true,
from: {
objType: {
serviceTag: "unitManager",
objectType: "unit"
},
linkType: "one",
},
to: {
objType: {
serviceTag: "unitType",
objectType: "unitTrackedProperty"
},
linkType: "many",
}
}
]
}
}
]
</syntaxhighlight>

* old unitTrackedProperties for a unit, maintains a history of unitTrackedProperty propertyValue changes
* when a change is made to a unitTrackedProperty propertyValue a new unitTrackedProperty is created and hasUnitTrackedProperty links to unitStandard, while old hasUnitTrackedProperty relationship is removed and replaced with a oldUnitTrackedProperty

= Working documents =

[[:Category:Working_documents - Unit Type|Unit Type]]

[[Category:Backend services| Unit Type]]

2025-03-06 - Graph Handler Docs

2026-06-03T06:23:05Z

Seagame: /* Request Example */

= GraphHandler Function =
== CreateNode ==
'''Use Case of CreateNode''' >>> https://izara.io/wiki/index.php/2025-03-27_Graph_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
* setFieldConditionals
** type : array
** Required : optional
* deepPathConditional
** type : array
** Required : optional
* parentFlowId
** type : string
** Required: true
* callingFlowConfig
** Type: object
** Required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType": {
"objectType": string,
"serviceTag": string
},
"objInstanceFull": {
"identifiers": {
// ...identifier
},
"fields": {
// ...fields
}
},
setFieldConditionals: [ // optional default array
{
objType: { },
indexValue: { nameSpace: 'ex-011', systemTextTag: 'Gate-011' }, // index field : value
fieldName: '', // fieldName want to set
passValue: 'false', optional
notPassValue: 'true', //optional
conditionals: [ optional ] // condition check field
}
],
"relationships": [
{
"relType": {
"serviceTag": string,
"relationshipTag": string
},
"relationshipProperties": {
//... key and value of targetIdentifiers
},
"relationshipDirection": string, // "from" | "to"
"targetObjType": {
"serviceTag": string,
"objectType": string
},
"targetIdentifiers": {
//... targetIdentifiers
}
}
],
deepPathConditional: [ // optional default array
{
condition: 'notExist', //
conditionCheck: { // traversal
nodeStructure: {
objType: { },
fields: { }
},
nextPath: {
relationshipStructure: {
relType: { },
relationshipDirection: 'to'
},
nodeStructure: {
objType: { },
fields: { }
}
}
}
}
],
"originTimestamp": number, // timestamp when create
"settings": {
"updatePropertiesOnMatch": boolean // default=false
},
"parentFlowId": "", // required
"callingFlow": string,
"callingFlowProperties": object,
}
</syntaxhighlight>

=== 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.relationships
** Type: array
** Description: data from relationships in targetNode
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* Status
** Type: string
** Description: Status from create node. Return "error" or "complete".
* errorsFound
** Type: array
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">

{
returnValue: {
queryResult: {
returnCreateNode: {
objTypes: [
{
serviceTag: "string",
objectType: "string"
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//...fields
}
},
existsNode: { },
userNode: { // // if has userNode send to createNode
objTypes: [
{
"serviceTag": "UserAccount",
"objectType": "user"
}
],
properties: {
//...properties
}
},
relationships: [ // optional : if has requiredOnCreated , createNode with targetNode
{
objTypes: [
{ serviceTag: 'string', objectType: 'string' }
],
objInstanceFull: {
identifiers: {
// identifiers
}
},
relType: {
serviceTag: 'string',
relationshipTag: 'rel'
},
relationshipProperties: {
// properties
}
},
]
}
},
requestParams: {
// return example send param
},
parentFlowId:""
},
status: "string", // "complete' or "error"
errorsFound: [],
graphServiceTag: "GraphHandler"
}

</syntaxhighlight>

== GetNode ==
'''Use Case of GetNode''' >>> https://izara.io/wiki/index.php/2025-04-23_Graph_Use_Case/GetNode_and_GetNodes#Use_Case_GetNodes
=== 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
* versionedDataLabels
** Type: Array
** Required : optional
* settings.updatePropertiesOnMatch
** Type: Boolean
** Required : optional
* parentFlowId
** Type: string
** Required: optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":string,
"objectType":string
},
"objInstanceFull":{
"identifiers":{
// ...identifier
},
"fields":{
// ...fields
}
},
"versionedDataLabels":[
//…versionedData
],
"settings": {
"returnSystemFieldsName" :boolean // default = true or false
},
"parentFlowId" : "" // optional
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* returnValue.queryResult
** Type: object
* queryResult.refactoredNodes
** Type: object
** Description: return object from getNode
* refactoredNodes.objTypes
** Type: array
* refactoredNodes.objInstanceFull
** Type: object
* refactoredNodes.objInstanceFull.identifiers
** Type: object
* refactoredNodes.objInstanceFull.fields
** Type: object
* refactoredNodes.versionDataSystemFields
** Type: object
* refactoredNodes.versionDataSystemFields.versionedDataLabel
** Type: object
* queryResult.requestParam
** Type: object
** Description: return example send param
* errorsFound
** Type: string
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
refactoredNodes: {
objTypes: [
{
serviceTag: "string",
objectType: "string",
}
],
objInstanceFull: {
identifiers: {
//… identifier
},
fields: {
//…fields
}
},
versionDataSystemFields: {
versionedDataLabel: {
originTimestamp: number,
forMatchedId: "string",
versionedDataId: "string"
}
}
}
},
requestParam: {
// return example send param
}
},
errorsFound: [],
graphServiceTag: ''
}
</syntaxhighlight>

== GetNodes ==
'''Use Case of GetNodes''' >>> https://izara.io/wiki/index.php/2025-04-23_Graph_Use_Case/GetNode_and_GetNodes#Use_Case_GetNodes
=== Request Parameters ===
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* fields
** Type : object
** Required: true
* versionedDataLabels
** Type: Array
** Required : optional
* settings.returnSystemFieldsName
** Type: Boolean
** Required : optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":string,
"objectType":string
},
"fields":{
//…fields with matching value
},
"versionedDataLabels":[
//…versionedDataLabels
],
"settings":{
"returnSystemFieldsName":boolean // default=false
},
"parentFlowId" :"" // optional
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResults
** Type: object
* queryResults.getNodesReturnValues
** Type: array
* getNodesReturnValues.objTypes
** Type: array
* getNodesReturnValues.objInstanceFull
** Type: object
* getNodesReturnValues.objInstanceFull.identifiers
** Type: object
* getNodesReturnValues.objInstanceFull.fields
** Type: object
* getNodesReturnValues.versionDataSystemFields
** Type: object
* getNodesReturnValues.versionDataSystemFields.versionedDataLabel
** Type: object
* requestParams
** Type: object
* errorsFound
** Type: string
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: {
getNodesReturnValues: [
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//.. all fields-1
}
},
versionDataSystemFields: {}
},
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//...all fields-2
}
},
versionDataSystemFields: {
versionedDataLabel: {
originTimestamp: number,
forMatchedId: 'string',
versionedDataId: 'string'
}
}
}
]
},
requestParams: {
// return example send param
}
}
}
</syntaxhighlight>

== UpdateNode ==
''' Use Case of UpdateNode''' >>> https://izara.io/wiki/index.php/2025-08-03_-_Graph_Use_Case/UpdateNode
=== 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: object
** Required : true
* objInstanceFull.fields
** Type : object
** Required: true
** Description : can not send fields to update mainNode and versionedData together
* versionedDataIds
** Type: object
** Required: optional
* originTimestamp
** Type: number
** Required: true
* settings
** Type: object
** Required: optional
* parentFlowId
** type : string
** Required: true
* callingFlow
** Type: string
** Required: optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType": {
"serviceTag": string,
"objectType": string
},
"objInstanceFull": {
"identifiers": {
//…identifiers
},
"fields": {
//…fields
// can not be send fields of mainNode and versionedData in fields together!
}
},
"versionedDataIds": {},
"originTimestamp": number, //// timestamp when update
"settings": {},
"parentFlowId": ""// required
"callingFlow": string
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* returnValue.queryResult
** Type: object
** Description: data from created node
* queryResult.objTypes
** Type: array
** Description: serviceTag and objectType
* queryResult.objInstanceFull
** Type: object
** Description: identifiers and fields
* queryResult.userId
** Type: object
** Description: data that update from user Account
* queryResult.versionDataSystemFields
** Type: object
** Description: optional return versionedData
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* returnValue.Status
** Type: string
** Description: status from updated node // error or complete
* returnValue.errorsFound
** Type: array
* returnValue.graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifiers
},
fields: {
//...fields
}
},
userId: {
// if have userNode send to updated
},
versionDataSystemFields: {
versionedDataLabel: {
}
}
},
requestParams: {
// return example send param
},
parentFlowId:""
},
status: 'string',//"complete" // "error"
errorsFound: [],
graphServiceTag: 'string'
}
</syntaxhighlight>

== CreateRelationship ==
''' Use Case of CreateRelationship''' >>> https://izara.io/wiki/index.php/2025-08-01_-_Graph_Use_Case/CreateRelationship
=== Request Parameters ===
* firstObject
** Type: object
** Required: true
* secondObject
** Type: object
** Required: true
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* identifiers
** Type: object
** Required : true
* additionalRelationships
** Type: array of object
** Required: optional
* relType
** Type: object
** Required: true
* relationshipDirection
** Type: string
** Required: true
* relationshipProperties
** Type: object
** Required: true
* deepPathConditional
** Type : array
** Required: optional
** Description : using deepPathConditional for check relationship if not exist , can check on firstNode and seconNode or additionalRelationships
* Settings
** Type: object
** Required: true
* settings.updateRelPropsWhenExist
** Type: boolean
** Required: optional
* parentFlowId
** type : string
** Required: true
* callingFlow
** Type: string
** Required: optional
* callingFlowConfig
** Type: object
** Required: optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject": {
"objType": {
"serviceTag": string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"additionalRelationships": [
{
"objType": {
"serviceTag":string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"relType": {
"serviceTag":string,
"relationshipTag":string
},
"relationshipProperties": {
//…properties
},
"relationshipDirection":string ,// “from” , “to”
"deepPathConditional": []
}
]
},
"secondObject": {
"objType": {
"serviceTag":string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"additionalRelationships": [
//…optional
]
},
"relType": {
"serviceTag":string,
"relationshipTag":string
},
"relationshipDirection":string, // “from” , “to”
"relationshipProperties": {
//…properties
},
"deepPathConditional": [ // default []
{
condition: 'notExist',
conditionCheck: {
nodeStructure: {
objType: {

},
fields: { }
},
nextPath: {
relationshipStructure: {
relType: {

},
relationshipDirection: ''
},
nodeStructure: {
objType: {

},
fields: { }
}
}
}
}
]
"settings": {
"reateOnConditionalFail": false // true default = false
"updateRelPropsWhenExist": boolean,
},
"parentFlowId": "", // required
"callingFlow": "xxxx",
"callingFlowProperties": {
"graphServiceName": string
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.relationship
** Type: object
* queryResult.relationship.relType
** Type: object
* queryResult.relationship.relationshipProperties
** Type: object
* queryResult.firstNode
** Type: object
** Description: return data structure from firstNode
* queryResult.secondNode
** Type: object
** Description: return data structure from secondNode
* queryResult..onCreateAddRelationships
** Type: array
** Description: return data structure from onCreateAddRelationships
* returnValue.firstObject
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* Status
** Type: string
** Description: status from create node // error or complete
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
relationship: {
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//…properties
}
},
firstNode: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: { //… identifiers },
fields: {
//… all fields
}
},
onCreateAddRelationships: [
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//… identifiers
},
fields: {
//… all fields
}
},
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//… all properties
}
}
]
},
secondNode: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: { //… identifiers },
fields: {
//… all fields
}
},
onCreateAddRelationships: [
//… optional
]
}
}
}
}
requestParams: {
// return example send param

},
parentFlowId: "",
Status: 'string', //“complete” // “error”
errorsFound: []
}
}
</syntaxhighlight>

== GetRelationship ==
=== Request Parameters ===
* firstObject
** Type: object
** Required: optional
* secondObject
** Type: object
** Required: optional
* objType
** Type: object
** Required: true
** Description: has serviceTag and objectType
* identifiers
** Type: object
** Required: true
* relType
** Type: object
** Required: true
** Description: has relationshipTag and serviceTag
* relId
** Type: string
** Required: true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag":string,
"objectType":string
},
"identifiers":{
//…identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"relType":{ // required
"relationshipTag": string,
"serviceTag": string
},
"relId": 'string' // // required,
"parentFlow": "" // optional
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
* Type: object
* queryResult.relType
** Type: object
* queryResult.relationshipProperties
** Type: object
** Description: return relId and properties
* returnValue.toObject
** Type: object
** Description: return toObject if not send secondObject from param
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* errorsFound
** Type: array
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: {
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//…properties : 'string’
}
},
toObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: {
identifiers: {
//
},
fields: { }
}
},
requestParams: {
// return example send param
}
}
}

</syntaxhighlight>

== UpdateRelationship ==
=== Request Parameters ===
* firstObject
** Type: object
** Required: optional
* secondObject
** Type: object
** Required: Optional
* objType
** Type: object
** Required: true
** Description: has serviceTag and objectType
* identifiers
** Type: object
** Required: true
* relId
** Type: string
** Required: true
* relType
** Type: object
** Required: true
** Description: has relationshipTag and serviceTag
* relationshipProperties
** Type: object
** Required: true
** Description: send properties that want to update
* relationshipDirection
** Type: string
** Required: optional
* parentFlowId
** Type : string
** Required : true
* callingFlow
** Type: string
** Required: optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"relId": string,
"relType":{
"serviceTag":string,
"relationshipTag":string
},
"relationshipProperties":{
//… properties that want to update
},
"relationshipDirection": string, // "from" // “to”
"parentFlowId": ""// required
"callingFlow": string
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.firstObject And secondObject
** Type: object
** Description : return objType {seviceTag and objectType} And identifiers
* queryResult.relId
** Type: string
* queryResult.relType
** Type: object
** Description: return {seviceTag and relationshipTag}
* queryResult.relationshipDirection
** Type: string
* queryResult.updatePropertiesParam
** Type: object
** Description: return properties to updated
* queryResult.oldRelationshipProperties
** Type: object
** Description: return old properties before update
* queryResult.newRelationshipProperties
** Type: object
** Description: return new properties after updated
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type : string
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
firstObject: {
objType: {
serviceTag: "string",
objectType: "string"
},
identifiers: {
//…identifiers
}
},
secondObject: {
objType: {
serviceTag: "string",
objectType: "string"
},
identifiers: {
//…identifiers
}
},
relId: "string",
relType: {
serviceTag: "string",
relationshipTag: "string"
},
relationshipDirection: "string",
updatePropertiesParam: {
//… properties updated
},
oldRelationshipProperties: {
// … old properties before update
},
newRelationshipProperties: {
//… new properties after updated
}
}
},
requestParams: {
// return example send param
},
parentFlowId:"",
status: “string”, // "complete",”error”
errorsFound: []
}
</syntaxhighlight>

== GetNodeAndRelationship ==
=== Request Parameters ===
* sourceObjType
** Required: true
** Description: has serviceTag and objectType
* sourceIdentifiers
** Type: object
** Required: true
* sourceVersionedDataLabels
** Type: object
** Required: optional
* targetRelationships
** Type: Array
** Required: true
* relTypeAndDirection
** Type: object
** Required: true
* relTypeAndDirection.relType
** Type: object
** Required: true
** Description: has serviceTag and relationshipTag
* relTypeAndDirection.relationshipProperties
** Type: object
** Required: optional
* relTypeAndDirection.relationshipDirection
** Type: String
** Required: optional
* targetObjects
** Type: Array
** Required: Optional
* targetObjects.objType
** Type: object
** Required: required if send targetObjects in param
* targetObjects.identifiers
** Type: object
** Required: optional should have objType if identifiers exists
* targetObjects.versionedDataLabels
** Type: object
** Required: optional have objType if versionedDataLabels exists

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"sourceObjType": { // required
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"sourceIdentifiers": {}, // required
"sourceVersionedDataLabels": [], // optional
"targetRelationships": [ //required
{
"relTypeAndDirection": { // required
"relType": {
"serviceTag": "xxxx",
"relationshipTag": "rel"
},
"relationshipProperties": {},//optional
"relationshipDirection": "" // required
},
"targetObjects": [ // optional
{
"objType": {
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"identifiers": {}, // optional
"versionedDataLabels": [] // optional have objType if versionedDataLabels exists
}
]
},
// if have multiple relTypeAndDirection
],
"settings": {} // defaulf = false >>> if have versionedDataLabels want to return all field of versionedata: settings = { returnSystemFieldsName: true }
"parentFlowId": "" // optional
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.objTypes
** Type: array of object
** Description: return {serviceTag and objectType}
* queryResult.objInstanceFull
** Type: object
** Description: return {identifiers and fields}
* queryResult.relNodes:
** Type: array
* relNodes.relType
** Type: object
** Description: return {serviceTag and relationshipTag}
* relNodes.relationshipProperties
** Type: object
* relNodes.objTypes
** Type: array of object
** Description: return {serviceTag and objectType}
* relNodes.objInstanceFull
** Type: object
** Description: return {identifiers and fields}
* requestParams
** Type: object
** Description: return same requestParams
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: {},
fields: { }
},
relNodes: [
{
relType: {
serviceTag: 'xxxx',
relationshipTag: 'rel'
},
relationshipProperties: { },
objTypes: [
{
serviceTag: 'xxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: {},
fields: {
// field
}
},
versionDataSystemFields: {
'0VersionDataLabel': {
originTimestamp:
forMatchedId:
versionedDataId:
}
}
}
]
}
},
requestParam : {
// return example send param
},
errorsFound: [],
graphServiceTag: "GraphHandler"
}

</syntaxhighlight>

== ChangeRelationshipType ==
=== Request Parameters ===
* firstObject
** Type : object
** Required : true
* secondObject
** Type : object
** Required : true
* objType
** Type : object
** Required : true
* Identifiers
** Type : object
** Required : true
* oldRelTypeAndDirection
** Type : object
** Required : true
* oldRelTypeAndDirection.relType
** Type : object
** Required : true
* oldRelTypeAndDirection.relationshipDirection
** Type : string
** Required : true
* oldRelTypeAndDirection.relationshipProperties
** Type : object
** Required : optional
* newRelType
** Type : object
** Required : true
* originTimestamp
** Type : number
** Required : true
* changedByUserId
** Type : String
** Required : true
* callingFlow
** Type : String
** Required : optional
* settings
** Type : object
** Required : optional
** Description : default > settings.changeMultipleRelationships : false // if send settings.changeMultipleRelationships : true >> can change multiple relType

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"secondObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"oldRelTypeAndDirection":{
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"old"
},
"relationshipDirection":"from",
"relationshipProperties":{
//Properties
}
},
"newRelType":{
"serviceTag":"xxxx",
"relationshipTag":"new"
},
"originTimestamp":1234567890,
"changedByUserId":"xxxx",
"callingFlow":"yyyy",
"settings":{
"changeMultipleRelationships": boolean: // default false
}
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.newRelationshipType
** Type: object
* newRelationshipType.relType
** Type: object
* newRelationshipType.relationshipDirection
** Type: string
* newRelationshipType.relationshipProperties
** Type: object
* queryResult.oldRelationshipType
** Type: object
* oldRelationshipType.relType
** Type: object
* oldRelationshipType.relationshipDirection
** Type: string
* oldRelationshipType.relationshipProperties
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
newRelationshipType: {
relType: {
serviceTag: "xxxx",
relationshipTag: "new"
},
relationshipDirection: "" // 'from' or 'to'
relationshipProperties: {}
},
oldRelationshipType: {
relType: {
serviceTag: "xxxx",
relationshipTag: "old"
},
relationshipDirection: "" // 'from' or 'to'
relationshipProperties: {}
}
},
requestParams : {
// return example send param
}
},
status: "complete" // or error,
errorsFound: [],
graphServiceTag : 'GraphHandeler'
}

</syntaxhighlight>

== DeleteRelationship ==
=== Request Parameters ===
* fromObject
** Type : object
** Required : optional
* secondObject
** Type : object
** Required : optional
* objType
** Type : object
** Required : true
* Identifiers
** Type : object
** Required : true
* relType
** Type : object
** Required : true
* relId
** Type: string
** Required : true
* relationshipDirection
** Type: string
** Required : optional
* callingFlow
** Type: string
** Required : true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"yyyy"
},
"relId":"string"
},
"relationshipDirection":"string"// "from" or "to"
"callingFlow":"string"
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.objects
** Type: array
* queryResult.objTypes
** Type: array
* queryResult.objInstanceFull.identifiers
** Type: object
* queryResult.objInstanceFull.fields
** Type: object
** Description: return data of fromObject and secondObject
* queryResult.userNode
** Type: object
** Description: return data of userNode
* queryResult.resultDeleteRel
** Type : string
** Description: return status Relationship Delete
* requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objects: [
{
objTypes: [
{
serviceTag: "xxxx",
objectType: "yyyy"
}
],
objInstanceFull: {
identifiers: {
// identifiers
},
fields: {
// fields
}
}
},
{
// if have multiple object objTypes
}
],
userNode: {
objTypes: [
{
serviceTag: "UserAccount",
objectType: "user"
}
],
objInstanceFull: {
identifiers: {
userId: "zzz"
}
}
},
resultDeleteRel: "Relationship Deleted" // default
},
requeatParam: {
// return example send param
},
status: "string", //default "complete" or "error"
errorsFound: []
}
}

</syntaxhighlight>

== DeleteNode ==
=== Request Parameters ===
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* identifiers
** Type : object
** Required: true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":"xxx",
"objectType":"yyy"
},
"identifiers":{
//
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResults
** Type: object
* queryResults.resultDeleteNode
** Type: Boolean
** Description: return status deleted node >> true or false
* requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
** Description: return status deleted node >> complete or error
* errorsFound
** Type: array
* graphServiceTag
** Type: string
=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: { resultDeleteNode: true }, // true or false
requestParams: {
// return example send param
}
},
status: 'string', // 'complete' or 'error'
errorsFound: [],
graphServiceTag: 'GraphHandler'
}
</syntaxhighlight>

== MoveRelationship ==

=== Request Parameters ===
* sourceObject
** Type : object
** Required : true
** Description: required objType: {serviceTag , objectType} and identifiers
* targetObjType
** Type : object
** Required : true
** Description: required objType: {serviceTag , objectType}
* relType
** Type : object
** Required : true
** Description: required objType: {serviceTag , relationshipTag}
* relationshipDirection
** Type : object
** Required : true
* moveToIdentifiers
** Type : object
** Required : true
* moveByUserId
** Type : String
** Required : true
* originTimestamp
** Type : number
** Required : true
* settings
** Type : object
** Required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"sourceObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyy"
},
"identifiers":{
// identifiers
}
},
"targetObjType":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
}
},
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"rel"
},
"relationshipDirection":"from", // "to"
"moveToIdentifiers":{
// target identifiers
},
"moveByUserId":"xxxx",
"originTimestamp":1234567890,
"settings":{}
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.moveRelationship
** Type: object
* moveRelationship.sourceObject
** Type: object
** Description: return data of sourceObject
* moveRelationship.relationship
** Type: string
** Description: return data of after move relationship
* moveRelationship.moveToObject
** Type: object
** Description: return data of moveToObject
* moveRelationship.historyData
** Type: object
** Description: return properties {old target identifiers and originTimestamp} after moveRelationship
* moveRelationship.userNode
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
moveRelationship: {
sourceObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
}
},
relationship: {
relType: {
serviceTag: 'xxxx',
relationshipTag: 'rel'
},
relationshipProperties: { originTimestamp: 1234567890 }
},
moveToObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: { }
},
historyData: {
relationshipProperties: { }
},
userNode: {
objTypes: [{ serviceTag: 'UserAccount', objectType: 'user' }],
objInstanceFull: { }
}
}
},
requestParam: {
}
}
status: "complete" // or error,
errorsFound: [],
graphServiceTag: 'GraphHandler'
}

</syntaxhighlight>

== MoveNodeProperties ==
=== Request Parameters ===
* sourceObject
** type: object
** required : true
* targetIdentifiers
** type : object
** required : true
* moveProperties
** type : array
** required : true // index minimum = 1
* updateProperties
** type : object
** required : true
* movePropertiesConditions
** type : array
** required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
sourceObject: {
objType: { },
identifier: { }
},
targetIdentifiers: { },
moveProperties: [ ],
updateProperties: { },
movePropertiesConditions: [ // optional
{
checkObject: 'target', // "source" | "target"
onSetObject: 'target', // "source" | "target"
onPassValue: true,
onNotPassCondition: false, // optional
fieldNameConditions: [ ]
}
]
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.moveNodeProperties
** Type: object
* moveNodeProperties.sourceObject
** Type: object
** Description: return data of sourceObject
* moveRelationship.moveFieldToObject
** Type: string
** Description: return data after moveFieldToObject
* moveRelationship.movedFields
** Type: object
** Description: return data field of moveToObject
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String
=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
moveNodeProperties: {
sourceObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: {
identifiers: { },
fields: { }
}
},
moveFieldToObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: { },
fields: {

}
},
movedFields: { Fields: { } } //
}
}
},
requestParam: { },
status: 'complete',
errorsFound: [],
graphServiceTag: 'GraphHandler'
}
</syntaxhighlight>
[[Category:Working documents| 2025-03-06]]

2025-03-06 - Graph Handler Docs

2026-06-03T06:21:53Z

Seagame: /* UpdateRelationship */

= GraphHandler Function =
== CreateNode ==
'''Use Case of CreateNode''' >>> https://izara.io/wiki/index.php/2025-03-27_Graph_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
* setFieldConditionals
** type : array
** Required : optional
* deepPathConditional
** type : array
** Required : optional
* parentFlowId
** type : string
** Required: true
* callingFlowConfig
** Type: object
** Required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType": {
"objectType": string,
"serviceTag": string
},
"objInstanceFull": {
"identifiers": {
// ...identifier
},
"fields": {
// ...fields
}
},
setFieldConditionals: [ // optional default array
{
objType: { },
indexValue: { nameSpace: 'ex-011', systemTextTag: 'Gate-011' }, // index field : value
fieldName: '', // fieldName want to set
passValue: 'false', optional
notPassValue: 'true', //optional
conditionals: [ optional ] // condition check field
}
],
"relationships": [
{
"relType": {
"serviceTag": string,
"relationshipTag": string
},
"relationshipProperties": {
//... key and value of targetIdentifiers
},
"relationshipDirection": string, // "from" | "to"
"targetObjType": {
"serviceTag": string,
"objectType": string
},
"targetIdentifiers": {
//... targetIdentifiers
}
}
],
deepPathConditional: [ // optional default array
{
condition: 'notExist', //
conditionCheck: { // traversal
nodeStructure: {
objType: { },
fields: { }
},
nextPath: {
relationshipStructure: {
relType: { },
relationshipDirection: 'to'
},
nodeStructure: {
objType: { },
fields: { }
}
}
}
}
],
"originTimestamp": number, // timestamp when create
"settings": {
"updatePropertiesOnMatch": boolean // default=false
},
"parentFlowId": "", // required
"callingFlow": string,
"callingFlowProperties": object,
}
</syntaxhighlight>

=== 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.relationships
** Type: array
** Description: data from relationships in targetNode
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* Status
** Type: string
** Description: Status from create node. Return "error" or "complete".
* errorsFound
** Type: array
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">

{
returnValue: {
queryResult: {
returnCreateNode: {
objTypes: [
{
serviceTag: "string",
objectType: "string"
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//...fields
}
},
existsNode: { },
userNode: { // // if has userNode send to createNode
objTypes: [
{
"serviceTag": "UserAccount",
"objectType": "user"
}
],
properties: {
//...properties
}
},
relationships: [ // optional : if has requiredOnCreated , createNode with targetNode
{
objTypes: [
{ serviceTag: 'string', objectType: 'string' }
],
objInstanceFull: {
identifiers: {
// identifiers
}
},
relType: {
serviceTag: 'string',
relationshipTag: 'rel'
},
relationshipProperties: {
// properties
}
},
]
}
},
requestParams: {
// return example send param
},
parentFlowId:""
},
status: "string", // "complete' or "error"
errorsFound: [],
graphServiceTag: "GraphHandler"
}

</syntaxhighlight>

== GetNode ==
'''Use Case of GetNode''' >>> https://izara.io/wiki/index.php/2025-04-23_Graph_Use_Case/GetNode_and_GetNodes#Use_Case_GetNodes
=== 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
* versionedDataLabels
** Type: Array
** Required : optional
* settings.updatePropertiesOnMatch
** Type: Boolean
** Required : optional
* parentFlowId
** Type: string
** Required: optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":string,
"objectType":string
},
"objInstanceFull":{
"identifiers":{
// ...identifier
},
"fields":{
// ...fields
}
},
"versionedDataLabels":[
//…versionedData
],
"settings": {
"returnSystemFieldsName" :boolean // default = true or false
},
"parentFlowId" : "" // optional
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* returnValue.queryResult
** Type: object
* queryResult.refactoredNodes
** Type: object
** Description: return object from getNode
* refactoredNodes.objTypes
** Type: array
* refactoredNodes.objInstanceFull
** Type: object
* refactoredNodes.objInstanceFull.identifiers
** Type: object
* refactoredNodes.objInstanceFull.fields
** Type: object
* refactoredNodes.versionDataSystemFields
** Type: object
* refactoredNodes.versionDataSystemFields.versionedDataLabel
** Type: object
* queryResult.requestParam
** Type: object
** Description: return example send param
* errorsFound
** Type: string
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
refactoredNodes: {
objTypes: [
{
serviceTag: "string",
objectType: "string",
}
],
objInstanceFull: {
identifiers: {
//… identifier
},
fields: {
//…fields
}
},
versionDataSystemFields: {
versionedDataLabel: {
originTimestamp: number,
forMatchedId: "string",
versionedDataId: "string"
}
}
}
},
requestParam: {
// return example send param
}
},
errorsFound: [],
graphServiceTag: ''
}
</syntaxhighlight>

== GetNodes ==
'''Use Case of GetNodes''' >>> https://izara.io/wiki/index.php/2025-04-23_Graph_Use_Case/GetNode_and_GetNodes#Use_Case_GetNodes
=== Request Parameters ===
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* fields
** Type : object
** Required: true
* versionedDataLabels
** Type: Array
** Required : optional
* settings.returnSystemFieldsName
** Type: Boolean
** Required : optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":string,
"objectType":string
},
"fields":{
//…fields with matching value
},
"versionedDataLabels":[
//…versionedDataLabels
],
"settings":{
"returnSystemFieldsName":boolean // default=false
},
"parentFlowId" :"" // optional
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResults
** Type: object
* queryResults.getNodesReturnValues
** Type: array
* getNodesReturnValues.objTypes
** Type: array
* getNodesReturnValues.objInstanceFull
** Type: object
* getNodesReturnValues.objInstanceFull.identifiers
** Type: object
* getNodesReturnValues.objInstanceFull.fields
** Type: object
* getNodesReturnValues.versionDataSystemFields
** Type: object
* getNodesReturnValues.versionDataSystemFields.versionedDataLabel
** Type: object
* requestParams
** Type: object
* errorsFound
** Type: string
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: {
getNodesReturnValues: [
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//.. all fields-1
}
},
versionDataSystemFields: {}
},
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//...all fields-2
}
},
versionDataSystemFields: {
versionedDataLabel: {
originTimestamp: number,
forMatchedId: 'string',
versionedDataId: 'string'
}
}
}
]
},
requestParams: {
// return example send param
}
}
}
</syntaxhighlight>

== UpdateNode ==
''' Use Case of UpdateNode''' >>> https://izara.io/wiki/index.php/2025-08-03_-_Graph_Use_Case/UpdateNode
=== 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: object
** Required : true
* objInstanceFull.fields
** Type : object
** Required: true
** Description : can not send fields to update mainNode and versionedData together
* versionedDataIds
** Type: object
** Required: optional
* originTimestamp
** Type: number
** Required: true
* settings
** Type: object
** Required: optional
* parentFlowId
** type : string
** Required: true
* callingFlow
** Type: string
** Required: optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType": {
"serviceTag": string,
"objectType": string
},
"objInstanceFull": {
"identifiers": {
//…identifiers
},
"fields": {
//…fields
// can not be send fields of mainNode and versionedData in fields together!
}
},
"versionedDataIds": {},
"originTimestamp": number, //// timestamp when update
"settings": {},
"parentFlowId": ""// required
"callingFlow": string
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* returnValue.queryResult
** Type: object
** Description: data from created node
* queryResult.objTypes
** Type: array
** Description: serviceTag and objectType
* queryResult.objInstanceFull
** Type: object
** Description: identifiers and fields
* queryResult.userId
** Type: object
** Description: data that update from user Account
* queryResult.versionDataSystemFields
** Type: object
** Description: optional return versionedData
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* returnValue.Status
** Type: string
** Description: status from updated node // error or complete
* returnValue.errorsFound
** Type: array
* returnValue.graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifiers
},
fields: {
//...fields
}
},
userId: {
// if have userNode send to updated
},
versionDataSystemFields: {
versionedDataLabel: {
}
}
},
requestParams: {
// return example send param
},
parentFlowId:""
},
status: 'string',//"complete" // "error"
errorsFound: [],
graphServiceTag: 'string'
}
</syntaxhighlight>

== CreateRelationship ==
''' Use Case of CreateRelationship''' >>> https://izara.io/wiki/index.php/2025-08-01_-_Graph_Use_Case/CreateRelationship
=== Request Parameters ===
* firstObject
** Type: object
** Required: true
* secondObject
** Type: object
** Required: true
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* identifiers
** Type: object
** Required : true
* additionalRelationships
** Type: array of object
** Required: optional
* relType
** Type: object
** Required: true
* relationshipDirection
** Type: string
** Required: true
* relationshipProperties
** Type: object
** Required: true
* deepPathConditional
** Type : array
** Required: optional
** Description : using deepPathConditional for check relationship if not exist , can check on firstNode and seconNode or additionalRelationships
* Settings
** Type: object
** Required: true
* settings.updateRelPropsWhenExist
** Type: boolean
** Required: optional
* parentFlowId
** type : string
** Required: true
* callingFlow
** Type: string
** Required: optional
* callingFlowConfig
** Type: object
** Required: optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject": {
"objType": {
"serviceTag": string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"additionalRelationships": [
{
"objType": {
"serviceTag":string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"relType": {
"serviceTag":string,
"relationshipTag":string
},
"relationshipProperties": {
//…properties
},
"relationshipDirection":string ,// “from” , “to”
"deepPathConditional": []
}
]
},
"secondObject": {
"objType": {
"serviceTag":string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"additionalRelationships": [
//…optional
]
},
"relType": {
"serviceTag":string,
"relationshipTag":string
},
"relationshipDirection":string, // “from” , “to”
"relationshipProperties": {
//…properties
},
"deepPathConditional": [ // default []
{
condition: 'notExist',
conditionCheck: {
nodeStructure: {
objType: {

},
fields: { }
},
nextPath: {
relationshipStructure: {
relType: {

},
relationshipDirection: ''
},
nodeStructure: {
objType: {

},
fields: { }
}
}
}
}
]
"settings": {
"reateOnConditionalFail": false // true default = false
"updateRelPropsWhenExist": boolean,
},
"parentFlowId": "", // required
"callingFlow": "xxxx",
"callingFlowProperties": {
"graphServiceName": string
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.relationship
** Type: object
* queryResult.relationship.relType
** Type: object
* queryResult.relationship.relationshipProperties
** Type: object
* queryResult.firstNode
** Type: object
** Description: return data structure from firstNode
* queryResult.secondNode
** Type: object
** Description: return data structure from secondNode
* queryResult..onCreateAddRelationships
** Type: array
** Description: return data structure from onCreateAddRelationships
* returnValue.firstObject
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* Status
** Type: string
** Description: status from create node // error or complete
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
relationship: {
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//…properties
}
},
firstNode: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: { //… identifiers },
fields: {
//… all fields
}
},
onCreateAddRelationships: [
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//… identifiers
},
fields: {
//… all fields
}
},
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//… all properties
}
}
]
},
secondNode: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: { //… identifiers },
fields: {
//… all fields
}
},
onCreateAddRelationships: [
//… optional
]
}
}
}
}
requestParams: {
// return example send param

},
parentFlowId: "",
Status: 'string', //“complete” // “error”
errorsFound: []
}
}
</syntaxhighlight>

== GetRelationship ==
=== Request Parameters ===
* firstObject
** Type: object
** Required: optional
* secondObject
** Type: object
** Required: optional
* objType
** Type: object
** Required: true
** Description: has serviceTag and objectType
* identifiers
** Type: object
** Required: true
* relType
** Type: object
** Required: true
** Description: has relationshipTag and serviceTag
* relId
** Type: string
** Required: true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag":string,
"objectType":string
},
"identifiers":{
//…identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"relType":{ // required
"relationshipTag": string,
"serviceTag": string
},
"relId": 'string' // // required,
"parentFlow": "" // optional
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
* Type: object
* queryResult.relType
** Type: object
* queryResult.relationshipProperties
** Type: object
** Description: return relId and properties
* returnValue.toObject
** Type: object
** Description: return toObject if not send secondObject from param
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* errorsFound
** Type: array
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: {
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//…properties : 'string’
}
},
toObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: {
identifiers: {
//
},
fields: { }
}
},
requestParams: {
// return example send param
}
}
}

</syntaxhighlight>

== UpdateRelationship ==
=== Request Parameters ===
* firstObject
** Type: object
** Required: optional
* secondObject
** Type: object
** Required: Optional
* objType
** Type: object
** Required: true
** Description: has serviceTag and objectType
* identifiers
** Type: object
** Required: true
* relId
** Type: string
** Required: true
* relType
** Type: object
** Required: true
** Description: has relationshipTag and serviceTag
* relationshipProperties
** Type: object
** Required: true
** Description: send properties that want to update
* relationshipDirection
** Type: string
** Required: optional
* parentFlowId
** Type : string
** Required : true
* callingFlow
** Type: string
** Required: optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"relId": string,
"relType":{
"serviceTag":string,
"relationshipTag":string
},
"relationshipProperties":{
//… properties that want to update
},
"relationshipDirection": string, // "from" // “to”
"parentFlowId": ""// required
"callingFlow": string
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.firstObject And secondObject
** Type: object
** Description : return objType {seviceTag and objectType} And identifiers
* queryResult.relId
** Type: string
* queryResult.relType
** Type: object
** Description: return {seviceTag and relationshipTag}
* queryResult.relationshipDirection
** Type: string
* queryResult.updatePropertiesParam
** Type: object
** Description: return properties to updated
* queryResult.oldRelationshipProperties
** Type: object
** Description: return old properties before update
* queryResult.newRelationshipProperties
** Type: object
** Description: return new properties after updated
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type : string
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
firstObject: {
objType: {
serviceTag: "string",
objectType: "string"
},
identifiers: {
//…identifiers
}
},
secondObject: {
objType: {
serviceTag: "string",
objectType: "string"
},
identifiers: {
//…identifiers
}
},
relId: "string",
relType: {
serviceTag: "string",
relationshipTag: "string"
},
relationshipDirection: "string",
updatePropertiesParam: {
//… properties updated
},
oldRelationshipProperties: {
// … old properties before update
},
newRelationshipProperties: {
//… new properties after updated
}
}
},
requestParams: {
// return example send param
},
parentFlowId:"",
status: “string”, // "complete",”error”
errorsFound: []
}
</syntaxhighlight>

== GetNodeAndRelationship ==
=== Request Parameters ===
* sourceObjType
** Required: true
** Description: has serviceTag and objectType
* sourceIdentifiers
** Type: object
** Required: true
* sourceVersionedDataLabels
** Type: object
** Required: optional
* targetRelationships
** Type: Array
** Required: true
* relTypeAndDirection
** Type: object
** Required: true
* relTypeAndDirection.relType
** Type: object
** Required: true
** Description: has serviceTag and relationshipTag
* relTypeAndDirection.relationshipProperties
** Type: object
** Required: optional
* relTypeAndDirection.relationshipDirection
** Type: String
** Required: optional
* targetObjects
** Type: Array
** Required: Optional
* targetObjects.objType
** Type: object
** Required: required if send targetObjects in param
* targetObjects.identifiers
** Type: object
** Required: optional should have objType if identifiers exists
* targetObjects.versionedDataLabels
** Type: object
** Required: optional have objType if versionedDataLabels exists

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"sourceObjType": { // required
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"sourceIdentifiers": {}, // required
"sourceVersionedDataLabels": [], // optional
"targetRelationships": [ //required
{
"relTypeAndDirection": { // required
"relType": {
"serviceTag": "xxxx",
"relationshipTag": "rel"
},
"relationshipProperties": {},//optional
"relationshipDirection": "" // required
},
"targetObjects": [ // optional
{
"objType": {
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"identifiers": {}, // optional
"versionedDataLabels": [] // optional have objType if versionedDataLabels exists
}
]
},
// if have multiple relTypeAndDirection
],
"settings": {} // defaulf = false >>> if have versionedDataLabels want to return all field of versionedata: settings = { returnSystemFieldsName: true }
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.objTypes
** Type: array of object
** Description: return {serviceTag and objectType}
* queryResult.objInstanceFull
** Type: object
** Description: return {identifiers and fields}
* queryResult.relNodes:
** Type: array
* relNodes.relType
** Type: object
** Description: return {serviceTag and relationshipTag}
* relNodes.relationshipProperties
** Type: object
* relNodes.objTypes
** Type: array of object
** Description: return {serviceTag and objectType}
* relNodes.objInstanceFull
** Type: object
** Description: return {identifiers and fields}
* requestParams
** Type: object
** Description: return same requestParams
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: {},
fields: { }
},
relNodes: [
{
relType: {
serviceTag: 'xxxx',
relationshipTag: 'rel'
},
relationshipProperties: { },
objTypes: [
{
serviceTag: 'xxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: {},
fields: {
// field
}
},
versionDataSystemFields: {
'0VersionDataLabel': {
originTimestamp:
forMatchedId:
versionedDataId:
}
}
}
]
}
},
requestParam : {
// return example send param
},
errorsFound: [],
graphServiceTag: "GraphHandler"
}

</syntaxhighlight>

== ChangeRelationshipType ==
=== Request Parameters ===
* firstObject
** Type : object
** Required : true
* secondObject
** Type : object
** Required : true
* objType
** Type : object
** Required : true
* Identifiers
** Type : object
** Required : true
* oldRelTypeAndDirection
** Type : object
** Required : true
* oldRelTypeAndDirection.relType
** Type : object
** Required : true
* oldRelTypeAndDirection.relationshipDirection
** Type : string
** Required : true
* oldRelTypeAndDirection.relationshipProperties
** Type : object
** Required : optional
* newRelType
** Type : object
** Required : true
* originTimestamp
** Type : number
** Required : true
* changedByUserId
** Type : String
** Required : true
* callingFlow
** Type : String
** Required : optional
* settings
** Type : object
** Required : optional
** Description : default > settings.changeMultipleRelationships : false // if send settings.changeMultipleRelationships : true >> can change multiple relType

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"secondObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"oldRelTypeAndDirection":{
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"old"
},
"relationshipDirection":"from",
"relationshipProperties":{
//Properties
}
},
"newRelType":{
"serviceTag":"xxxx",
"relationshipTag":"new"
},
"originTimestamp":1234567890,
"changedByUserId":"xxxx",
"callingFlow":"yyyy",
"settings":{
"changeMultipleRelationships": boolean: // default false
}
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.newRelationshipType
** Type: object
* newRelationshipType.relType
** Type: object
* newRelationshipType.relationshipDirection
** Type: string
* newRelationshipType.relationshipProperties
** Type: object
* queryResult.oldRelationshipType
** Type: object
* oldRelationshipType.relType
** Type: object
* oldRelationshipType.relationshipDirection
** Type: string
* oldRelationshipType.relationshipProperties
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
newRelationshipType: {
relType: {
serviceTag: "xxxx",
relationshipTag: "new"
},
relationshipDirection: "" // 'from' or 'to'
relationshipProperties: {}
},
oldRelationshipType: {
relType: {
serviceTag: "xxxx",
relationshipTag: "old"
},
relationshipDirection: "" // 'from' or 'to'
relationshipProperties: {}
}
},
requestParams : {
// return example send param
}
},
status: "complete" // or error,
errorsFound: [],
graphServiceTag : 'GraphHandeler'
}

</syntaxhighlight>

== DeleteRelationship ==
=== Request Parameters ===
* fromObject
** Type : object
** Required : optional
* secondObject
** Type : object
** Required : optional
* objType
** Type : object
** Required : true
* Identifiers
** Type : object
** Required : true
* relType
** Type : object
** Required : true
* relId
** Type: string
** Required : true
* relationshipDirection
** Type: string
** Required : optional
* callingFlow
** Type: string
** Required : true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"yyyy"
},
"relId":"string"
},
"relationshipDirection":"string"// "from" or "to"
"callingFlow":"string"
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.objects
** Type: array
* queryResult.objTypes
** Type: array
* queryResult.objInstanceFull.identifiers
** Type: object
* queryResult.objInstanceFull.fields
** Type: object
** Description: return data of fromObject and secondObject
* queryResult.userNode
** Type: object
** Description: return data of userNode
* queryResult.resultDeleteRel
** Type : string
** Description: return status Relationship Delete
* requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objects: [
{
objTypes: [
{
serviceTag: "xxxx",
objectType: "yyyy"
}
],
objInstanceFull: {
identifiers: {
// identifiers
},
fields: {
// fields
}
}
},
{
// if have multiple object objTypes
}
],
userNode: {
objTypes: [
{
serviceTag: "UserAccount",
objectType: "user"
}
],
objInstanceFull: {
identifiers: {
userId: "zzz"
}
}
},
resultDeleteRel: "Relationship Deleted" // default
},
requeatParam: {
// return example send param
},
status: "string", //default "complete" or "error"
errorsFound: []
}
}

</syntaxhighlight>

== DeleteNode ==
=== Request Parameters ===
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* identifiers
** Type : object
** Required: true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":"xxx",
"objectType":"yyy"
},
"identifiers":{
//
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResults
** Type: object
* queryResults.resultDeleteNode
** Type: Boolean
** Description: return status deleted node >> true or false
* requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
** Description: return status deleted node >> complete or error
* errorsFound
** Type: array
* graphServiceTag
** Type: string
=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: { resultDeleteNode: true }, // true or false
requestParams: {
// return example send param
}
},
status: 'string', // 'complete' or 'error'
errorsFound: [],
graphServiceTag: 'GraphHandler'
}
</syntaxhighlight>

== MoveRelationship ==

=== Request Parameters ===
* sourceObject
** Type : object
** Required : true
** Description: required objType: {serviceTag , objectType} and identifiers
* targetObjType
** Type : object
** Required : true
** Description: required objType: {serviceTag , objectType}
* relType
** Type : object
** Required : true
** Description: required objType: {serviceTag , relationshipTag}
* relationshipDirection
** Type : object
** Required : true
* moveToIdentifiers
** Type : object
** Required : true
* moveByUserId
** Type : String
** Required : true
* originTimestamp
** Type : number
** Required : true
* settings
** Type : object
** Required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"sourceObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyy"
},
"identifiers":{
// identifiers
}
},
"targetObjType":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
}
},
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"rel"
},
"relationshipDirection":"from", // "to"
"moveToIdentifiers":{
// target identifiers
},
"moveByUserId":"xxxx",
"originTimestamp":1234567890,
"settings":{}
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.moveRelationship
** Type: object
* moveRelationship.sourceObject
** Type: object
** Description: return data of sourceObject
* moveRelationship.relationship
** Type: string
** Description: return data of after move relationship
* moveRelationship.moveToObject
** Type: object
** Description: return data of moveToObject
* moveRelationship.historyData
** Type: object
** Description: return properties {old target identifiers and originTimestamp} after moveRelationship
* moveRelationship.userNode
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
moveRelationship: {
sourceObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
}
},
relationship: {
relType: {
serviceTag: 'xxxx',
relationshipTag: 'rel'
},
relationshipProperties: { originTimestamp: 1234567890 }
},
moveToObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: { }
},
historyData: {
relationshipProperties: { }
},
userNode: {
objTypes: [{ serviceTag: 'UserAccount', objectType: 'user' }],
objInstanceFull: { }
}
}
},
requestParam: {
}
}
status: "complete" // or error,
errorsFound: [],
graphServiceTag: 'GraphHandler'
}

</syntaxhighlight>

== MoveNodeProperties ==
=== Request Parameters ===
* sourceObject
** type: object
** required : true
* targetIdentifiers
** type : object
** required : true
* moveProperties
** type : array
** required : true // index minimum = 1
* updateProperties
** type : object
** required : true
* movePropertiesConditions
** type : array
** required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
sourceObject: {
objType: { },
identifier: { }
},
targetIdentifiers: { },
moveProperties: [ ],
updateProperties: { },
movePropertiesConditions: [ // optional
{
checkObject: 'target', // "source" | "target"
onSetObject: 'target', // "source" | "target"
onPassValue: true,
onNotPassCondition: false, // optional
fieldNameConditions: [ ]
}
]
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.moveNodeProperties
** Type: object
* moveNodeProperties.sourceObject
** Type: object
** Description: return data of sourceObject
* moveRelationship.moveFieldToObject
** Type: string
** Description: return data after moveFieldToObject
* moveRelationship.movedFields
** Type: object
** Description: return data field of moveToObject
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String
=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
moveNodeProperties: {
sourceObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: {
identifiers: { },
fields: { }
}
},
moveFieldToObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: { },
fields: {

}
},
movedFields: { Fields: { } } //
}
}
},
requestParam: { },
status: 'complete',
errorsFound: [],
graphServiceTag: 'GraphHandler'
}
</syntaxhighlight>
[[Category:Working documents| 2025-03-06]]

2025-03-06 - Graph Handler Docs

2026-06-03T06:18:52Z

Seagame: /* Request Example */

= GraphHandler Function =
== CreateNode ==
'''Use Case of CreateNode''' >>> https://izara.io/wiki/index.php/2025-03-27_Graph_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
* setFieldConditionals
** type : array
** Required : optional
* deepPathConditional
** type : array
** Required : optional
* parentFlowId
** type : string
** Required: true
* callingFlowConfig
** Type: object
** Required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType": {
"objectType": string,
"serviceTag": string
},
"objInstanceFull": {
"identifiers": {
// ...identifier
},
"fields": {
// ...fields
}
},
setFieldConditionals: [ // optional default array
{
objType: { },
indexValue: { nameSpace: 'ex-011', systemTextTag: 'Gate-011' }, // index field : value
fieldName: '', // fieldName want to set
passValue: 'false', optional
notPassValue: 'true', //optional
conditionals: [ optional ] // condition check field
}
],
"relationships": [
{
"relType": {
"serviceTag": string,
"relationshipTag": string
},
"relationshipProperties": {
//... key and value of targetIdentifiers
},
"relationshipDirection": string, // "from" | "to"
"targetObjType": {
"serviceTag": string,
"objectType": string
},
"targetIdentifiers": {
//... targetIdentifiers
}
}
],
deepPathConditional: [ // optional default array
{
condition: 'notExist', //
conditionCheck: { // traversal
nodeStructure: {
objType: { },
fields: { }
},
nextPath: {
relationshipStructure: {
relType: { },
relationshipDirection: 'to'
},
nodeStructure: {
objType: { },
fields: { }
}
}
}
}
],
"originTimestamp": number, // timestamp when create
"settings": {
"updatePropertiesOnMatch": boolean // default=false
},
"parentFlowId": "", // required
"callingFlow": string,
"callingFlowProperties": object,
}
</syntaxhighlight>

=== 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.relationships
** Type: array
** Description: data from relationships in targetNode
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* Status
** Type: string
** Description: Status from create node. Return "error" or "complete".
* errorsFound
** Type: array
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">

{
returnValue: {
queryResult: {
returnCreateNode: {
objTypes: [
{
serviceTag: "string",
objectType: "string"
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//...fields
}
},
existsNode: { },
userNode: { // // if has userNode send to createNode
objTypes: [
{
"serviceTag": "UserAccount",
"objectType": "user"
}
],
properties: {
//...properties
}
},
relationships: [ // optional : if has requiredOnCreated , createNode with targetNode
{
objTypes: [
{ serviceTag: 'string', objectType: 'string' }
],
objInstanceFull: {
identifiers: {
// identifiers
}
},
relType: {
serviceTag: 'string',
relationshipTag: 'rel'
},
relationshipProperties: {
// properties
}
},
]
}
},
requestParams: {
// return example send param
},
parentFlowId:""
},
status: "string", // "complete' or "error"
errorsFound: [],
graphServiceTag: "GraphHandler"
}

</syntaxhighlight>

== GetNode ==
'''Use Case of GetNode''' >>> https://izara.io/wiki/index.php/2025-04-23_Graph_Use_Case/GetNode_and_GetNodes#Use_Case_GetNodes
=== 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
* versionedDataLabels
** Type: Array
** Required : optional
* settings.updatePropertiesOnMatch
** Type: Boolean
** Required : optional
* parentFlowId
** Type: string
** Required: optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":string,
"objectType":string
},
"objInstanceFull":{
"identifiers":{
// ...identifier
},
"fields":{
// ...fields
}
},
"versionedDataLabels":[
//…versionedData
],
"settings": {
"returnSystemFieldsName" :boolean // default = true or false
},
"parentFlowId" : "" // optional
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* returnValue.queryResult
** Type: object
* queryResult.refactoredNodes
** Type: object
** Description: return object from getNode
* refactoredNodes.objTypes
** Type: array
* refactoredNodes.objInstanceFull
** Type: object
* refactoredNodes.objInstanceFull.identifiers
** Type: object
* refactoredNodes.objInstanceFull.fields
** Type: object
* refactoredNodes.versionDataSystemFields
** Type: object
* refactoredNodes.versionDataSystemFields.versionedDataLabel
** Type: object
* queryResult.requestParam
** Type: object
** Description: return example send param
* errorsFound
** Type: string
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
refactoredNodes: {
objTypes: [
{
serviceTag: "string",
objectType: "string",
}
],
objInstanceFull: {
identifiers: {
//… identifier
},
fields: {
//…fields
}
},
versionDataSystemFields: {
versionedDataLabel: {
originTimestamp: number,
forMatchedId: "string",
versionedDataId: "string"
}
}
}
},
requestParam: {
// return example send param
}
},
errorsFound: [],
graphServiceTag: ''
}
</syntaxhighlight>

== GetNodes ==
'''Use Case of GetNodes''' >>> https://izara.io/wiki/index.php/2025-04-23_Graph_Use_Case/GetNode_and_GetNodes#Use_Case_GetNodes
=== Request Parameters ===
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* fields
** Type : object
** Required: true
* versionedDataLabels
** Type: Array
** Required : optional
* settings.returnSystemFieldsName
** Type: Boolean
** Required : optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":string,
"objectType":string
},
"fields":{
//…fields with matching value
},
"versionedDataLabels":[
//…versionedDataLabels
],
"settings":{
"returnSystemFieldsName":boolean // default=false
},
"parentFlowId" :"" // optional
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResults
** Type: object
* queryResults.getNodesReturnValues
** Type: array
* getNodesReturnValues.objTypes
** Type: array
* getNodesReturnValues.objInstanceFull
** Type: object
* getNodesReturnValues.objInstanceFull.identifiers
** Type: object
* getNodesReturnValues.objInstanceFull.fields
** Type: object
* getNodesReturnValues.versionDataSystemFields
** Type: object
* getNodesReturnValues.versionDataSystemFields.versionedDataLabel
** Type: object
* requestParams
** Type: object
* errorsFound
** Type: string
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: {
getNodesReturnValues: [
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//.. all fields-1
}
},
versionDataSystemFields: {}
},
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//...all fields-2
}
},
versionDataSystemFields: {
versionedDataLabel: {
originTimestamp: number,
forMatchedId: 'string',
versionedDataId: 'string'
}
}
}
]
},
requestParams: {
// return example send param
}
}
}
</syntaxhighlight>

== UpdateNode ==
''' Use Case of UpdateNode''' >>> https://izara.io/wiki/index.php/2025-08-03_-_Graph_Use_Case/UpdateNode
=== 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: object
** Required : true
* objInstanceFull.fields
** Type : object
** Required: true
** Description : can not send fields to update mainNode and versionedData together
* versionedDataIds
** Type: object
** Required: optional
* originTimestamp
** Type: number
** Required: true
* settings
** Type: object
** Required: optional
* parentFlowId
** type : string
** Required: true
* callingFlow
** Type: string
** Required: optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType": {
"serviceTag": string,
"objectType": string
},
"objInstanceFull": {
"identifiers": {
//…identifiers
},
"fields": {
//…fields
// can not be send fields of mainNode and versionedData in fields together!
}
},
"versionedDataIds": {},
"originTimestamp": number, //// timestamp when update
"settings": {},
"parentFlowId": ""// required
"callingFlow": string
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* returnValue.queryResult
** Type: object
** Description: data from created node
* queryResult.objTypes
** Type: array
** Description: serviceTag and objectType
* queryResult.objInstanceFull
** Type: object
** Description: identifiers and fields
* queryResult.userId
** Type: object
** Description: data that update from user Account
* queryResult.versionDataSystemFields
** Type: object
** Description: optional return versionedData
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* returnValue.Status
** Type: string
** Description: status from updated node // error or complete
* returnValue.errorsFound
** Type: array
* returnValue.graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifiers
},
fields: {
//...fields
}
},
userId: {
// if have userNode send to updated
},
versionDataSystemFields: {
versionedDataLabel: {
}
}
},
requestParams: {
// return example send param
},
parentFlowId:""
},
status: 'string',//"complete" // "error"
errorsFound: [],
graphServiceTag: 'string'
}
</syntaxhighlight>

== CreateRelationship ==
''' Use Case of CreateRelationship''' >>> https://izara.io/wiki/index.php/2025-08-01_-_Graph_Use_Case/CreateRelationship
=== Request Parameters ===
* firstObject
** Type: object
** Required: true
* secondObject
** Type: object
** Required: true
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* identifiers
** Type: object
** Required : true
* additionalRelationships
** Type: array of object
** Required: optional
* relType
** Type: object
** Required: true
* relationshipDirection
** Type: string
** Required: true
* relationshipProperties
** Type: object
** Required: true
* deepPathConditional
** Type : array
** Required: optional
** Description : using deepPathConditional for check relationship if not exist , can check on firstNode and seconNode or additionalRelationships
* Settings
** Type: object
** Required: true
* settings.updateRelPropsWhenExist
** Type: boolean
** Required: optional
* parentFlowId
** type : string
** Required: true
* callingFlow
** Type: string
** Required: optional
* callingFlowConfig
** Type: object
** Required: optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject": {
"objType": {
"serviceTag": string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"additionalRelationships": [
{
"objType": {
"serviceTag":string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"relType": {
"serviceTag":string,
"relationshipTag":string
},
"relationshipProperties": {
//…properties
},
"relationshipDirection":string ,// “from” , “to”
"deepPathConditional": []
}
]
},
"secondObject": {
"objType": {
"serviceTag":string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"additionalRelationships": [
//…optional
]
},
"relType": {
"serviceTag":string,
"relationshipTag":string
},
"relationshipDirection":string, // “from” , “to”
"relationshipProperties": {
//…properties
},
"deepPathConditional": [ // default []
{
condition: 'notExist',
conditionCheck: {
nodeStructure: {
objType: {

},
fields: { }
},
nextPath: {
relationshipStructure: {
relType: {

},
relationshipDirection: ''
},
nodeStructure: {
objType: {

},
fields: { }
}
}
}
}
]
"settings": {
"reateOnConditionalFail": false // true default = false
"updateRelPropsWhenExist": boolean,
},
"parentFlowId": "", // required
"callingFlow": "xxxx",
"callingFlowProperties": {
"graphServiceName": string
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.relationship
** Type: object
* queryResult.relationship.relType
** Type: object
* queryResult.relationship.relationshipProperties
** Type: object
* queryResult.firstNode
** Type: object
** Description: return data structure from firstNode
* queryResult.secondNode
** Type: object
** Description: return data structure from secondNode
* queryResult..onCreateAddRelationships
** Type: array
** Description: return data structure from onCreateAddRelationships
* returnValue.firstObject
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* Status
** Type: string
** Description: status from create node // error or complete
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
relationship: {
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//…properties
}
},
firstNode: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: { //… identifiers },
fields: {
//… all fields
}
},
onCreateAddRelationships: [
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//… identifiers
},
fields: {
//… all fields
}
},
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//… all properties
}
}
]
},
secondNode: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: { //… identifiers },
fields: {
//… all fields
}
},
onCreateAddRelationships: [
//… optional
]
}
}
}
}
requestParams: {
// return example send param

},
parentFlowId: "",
Status: 'string', //“complete” // “error”
errorsFound: []
}
}
</syntaxhighlight>

== GetRelationship ==
=== Request Parameters ===
* firstObject
** Type: object
** Required: optional
* secondObject
** Type: object
** Required: optional
* objType
** Type: object
** Required: true
** Description: has serviceTag and objectType
* identifiers
** Type: object
** Required: true
* relType
** Type: object
** Required: true
** Description: has relationshipTag and serviceTag
* relId
** Type: string
** Required: true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag":string,
"objectType":string
},
"identifiers":{
//…identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"relType":{ // required
"relationshipTag": string,
"serviceTag": string
},
"relId": 'string' // // required,
"parentFlow": "" // optional
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
* Type: object
* queryResult.relType
** Type: object
* queryResult.relationshipProperties
** Type: object
** Description: return relId and properties
* returnValue.toObject
** Type: object
** Description: return toObject if not send secondObject from param
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* errorsFound
** Type: array
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: {
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//…properties : 'string’
}
},
toObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: {
identifiers: {
//
},
fields: { }
}
},
requestParams: {
// return example send param
}
}
}

</syntaxhighlight>

== UpdateRelationship ==
=== Request Parameters ===
* firstObject
** Type: object
** Required: optional
* secondObject
** Type: object
** Required: Optional
* objType
** Type: object
** Required: true
** Description: has serviceTag and objectType
* identifiers
** Type: object
** Required: true
* relId
** Type: string
** Required: true
* relType
** Type: object
** Required: true
** Description: has relationshipTag and serviceTag
* relationshipProperties
** Type: object
** Required: true
** Description: send properties that want to update
* relationshipDirection
** Type: string
** Required: optional
* callingFlow
** Type: string
** Required: optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"relId": string,
"relType":{
"serviceTag":string,
"relationshipTag":string
},
"relationshipProperties":{
//… properties that want to update
},
"relationshipDirection": string, // "from" // “to”
"callingFlow": string
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.firstObject And secondObject
** Type: object
** Description : return objType {seviceTag and objectType} And identifiers
* queryResult.relId
** Type: string
* queryResult.relType
** Type: object
** Description: return {seviceTag and relationshipTag}
* queryResult.relationshipDirection
** Type: string
* queryResult.updatePropertiesParam
** Type: object
** Description: return properties to updated
* queryResult.oldRelationshipProperties
** Type: object
** Description: return old properties before update
* queryResult.newRelationshipProperties
** Type: object
** Description: return new properties after updated
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type : string
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
firstObject: {
objType: {
serviceTag: "string",
objectType: "string"
},
identifiers: {
//…identifiers
}
},
secondObject: {
objType: {
serviceTag: "string",
objectType: "string"
},
identifiers: {
//…identifiers
}
},
relId: "string",
relType: {
serviceTag: "string",
relationshipTag: "string"
},
relationshipDirection: "string",
updatePropertiesParam: {
//… properties updated
},
oldRelationshipProperties: {
// … old properties before update
},
newRelationshipProperties: {
//… new properties after updated
}
}
},
requestParams: {
// return example send param
}
status: “string”, // "complete",”error”
errorsFound: []
}
</syntaxhighlight>

== GetNodeAndRelationship ==
=== Request Parameters ===
* sourceObjType
** Required: true
** Description: has serviceTag and objectType
* sourceIdentifiers
** Type: object
** Required: true
* sourceVersionedDataLabels
** Type: object
** Required: optional
* targetRelationships
** Type: Array
** Required: true
* relTypeAndDirection
** Type: object
** Required: true
* relTypeAndDirection.relType
** Type: object
** Required: true
** Description: has serviceTag and relationshipTag
* relTypeAndDirection.relationshipProperties
** Type: object
** Required: optional
* relTypeAndDirection.relationshipDirection
** Type: String
** Required: optional
* targetObjects
** Type: Array
** Required: Optional
* targetObjects.objType
** Type: object
** Required: required if send targetObjects in param
* targetObjects.identifiers
** Type: object
** Required: optional should have objType if identifiers exists
* targetObjects.versionedDataLabels
** Type: object
** Required: optional have objType if versionedDataLabels exists

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"sourceObjType": { // required
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"sourceIdentifiers": {}, // required
"sourceVersionedDataLabels": [], // optional
"targetRelationships": [ //required
{
"relTypeAndDirection": { // required
"relType": {
"serviceTag": "xxxx",
"relationshipTag": "rel"
},
"relationshipProperties": {},//optional
"relationshipDirection": "" // required
},
"targetObjects": [ // optional
{
"objType": {
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"identifiers": {}, // optional
"versionedDataLabels": [] // optional have objType if versionedDataLabels exists
}
]
},
// if have multiple relTypeAndDirection
],
"settings": {} // defaulf = false >>> if have versionedDataLabels want to return all field of versionedata: settings = { returnSystemFieldsName: true }
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.objTypes
** Type: array of object
** Description: return {serviceTag and objectType}
* queryResult.objInstanceFull
** Type: object
** Description: return {identifiers and fields}
* queryResult.relNodes:
** Type: array
* relNodes.relType
** Type: object
** Description: return {serviceTag and relationshipTag}
* relNodes.relationshipProperties
** Type: object
* relNodes.objTypes
** Type: array of object
** Description: return {serviceTag and objectType}
* relNodes.objInstanceFull
** Type: object
** Description: return {identifiers and fields}
* requestParams
** Type: object
** Description: return same requestParams
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: {},
fields: { }
},
relNodes: [
{
relType: {
serviceTag: 'xxxx',
relationshipTag: 'rel'
},
relationshipProperties: { },
objTypes: [
{
serviceTag: 'xxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: {},
fields: {
// field
}
},
versionDataSystemFields: {
'0VersionDataLabel': {
originTimestamp:
forMatchedId:
versionedDataId:
}
}
}
]
}
},
requestParam : {
// return example send param
},
errorsFound: [],
graphServiceTag: "GraphHandler"
}

</syntaxhighlight>

== ChangeRelationshipType ==
=== Request Parameters ===
* firstObject
** Type : object
** Required : true
* secondObject
** Type : object
** Required : true
* objType
** Type : object
** Required : true
* Identifiers
** Type : object
** Required : true
* oldRelTypeAndDirection
** Type : object
** Required : true
* oldRelTypeAndDirection.relType
** Type : object
** Required : true
* oldRelTypeAndDirection.relationshipDirection
** Type : string
** Required : true
* oldRelTypeAndDirection.relationshipProperties
** Type : object
** Required : optional
* newRelType
** Type : object
** Required : true
* originTimestamp
** Type : number
** Required : true
* changedByUserId
** Type : String
** Required : true
* callingFlow
** Type : String
** Required : optional
* settings
** Type : object
** Required : optional
** Description : default > settings.changeMultipleRelationships : false // if send settings.changeMultipleRelationships : true >> can change multiple relType

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"secondObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"oldRelTypeAndDirection":{
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"old"
},
"relationshipDirection":"from",
"relationshipProperties":{
//Properties
}
},
"newRelType":{
"serviceTag":"xxxx",
"relationshipTag":"new"
},
"originTimestamp":1234567890,
"changedByUserId":"xxxx",
"callingFlow":"yyyy",
"settings":{
"changeMultipleRelationships": boolean: // default false
}
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.newRelationshipType
** Type: object
* newRelationshipType.relType
** Type: object
* newRelationshipType.relationshipDirection
** Type: string
* newRelationshipType.relationshipProperties
** Type: object
* queryResult.oldRelationshipType
** Type: object
* oldRelationshipType.relType
** Type: object
* oldRelationshipType.relationshipDirection
** Type: string
* oldRelationshipType.relationshipProperties
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
newRelationshipType: {
relType: {
serviceTag: "xxxx",
relationshipTag: "new"
},
relationshipDirection: "" // 'from' or 'to'
relationshipProperties: {}
},
oldRelationshipType: {
relType: {
serviceTag: "xxxx",
relationshipTag: "old"
},
relationshipDirection: "" // 'from' or 'to'
relationshipProperties: {}
}
},
requestParams : {
// return example send param
}
},
status: "complete" // or error,
errorsFound: [],
graphServiceTag : 'GraphHandeler'
}

</syntaxhighlight>

== DeleteRelationship ==
=== Request Parameters ===
* fromObject
** Type : object
** Required : optional
* secondObject
** Type : object
** Required : optional
* objType
** Type : object
** Required : true
* Identifiers
** Type : object
** Required : true
* relType
** Type : object
** Required : true
* relId
** Type: string
** Required : true
* relationshipDirection
** Type: string
** Required : optional
* callingFlow
** Type: string
** Required : true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"yyyy"
},
"relId":"string"
},
"relationshipDirection":"string"// "from" or "to"
"callingFlow":"string"
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.objects
** Type: array
* queryResult.objTypes
** Type: array
* queryResult.objInstanceFull.identifiers
** Type: object
* queryResult.objInstanceFull.fields
** Type: object
** Description: return data of fromObject and secondObject
* queryResult.userNode
** Type: object
** Description: return data of userNode
* queryResult.resultDeleteRel
** Type : string
** Description: return status Relationship Delete
* requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objects: [
{
objTypes: [
{
serviceTag: "xxxx",
objectType: "yyyy"
}
],
objInstanceFull: {
identifiers: {
// identifiers
},
fields: {
// fields
}
}
},
{
// if have multiple object objTypes
}
],
userNode: {
objTypes: [
{
serviceTag: "UserAccount",
objectType: "user"
}
],
objInstanceFull: {
identifiers: {
userId: "zzz"
}
}
},
resultDeleteRel: "Relationship Deleted" // default
},
requeatParam: {
// return example send param
},
status: "string", //default "complete" or "error"
errorsFound: []
}
}

</syntaxhighlight>

== DeleteNode ==
=== Request Parameters ===
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* identifiers
** Type : object
** Required: true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":"xxx",
"objectType":"yyy"
},
"identifiers":{
//
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResults
** Type: object
* queryResults.resultDeleteNode
** Type: Boolean
** Description: return status deleted node >> true or false
* requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
** Description: return status deleted node >> complete or error
* errorsFound
** Type: array
* graphServiceTag
** Type: string
=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: { resultDeleteNode: true }, // true or false
requestParams: {
// return example send param
}
},
status: 'string', // 'complete' or 'error'
errorsFound: [],
graphServiceTag: 'GraphHandler'
}
</syntaxhighlight>

== MoveRelationship ==

=== Request Parameters ===
* sourceObject
** Type : object
** Required : true
** Description: required objType: {serviceTag , objectType} and identifiers
* targetObjType
** Type : object
** Required : true
** Description: required objType: {serviceTag , objectType}
* relType
** Type : object
** Required : true
** Description: required objType: {serviceTag , relationshipTag}
* relationshipDirection
** Type : object
** Required : true
* moveToIdentifiers
** Type : object
** Required : true
* moveByUserId
** Type : String
** Required : true
* originTimestamp
** Type : number
** Required : true
* settings
** Type : object
** Required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"sourceObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyy"
},
"identifiers":{
// identifiers
}
},
"targetObjType":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
}
},
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"rel"
},
"relationshipDirection":"from", // "to"
"moveToIdentifiers":{
// target identifiers
},
"moveByUserId":"xxxx",
"originTimestamp":1234567890,
"settings":{}
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.moveRelationship
** Type: object
* moveRelationship.sourceObject
** Type: object
** Description: return data of sourceObject
* moveRelationship.relationship
** Type: string
** Description: return data of after move relationship
* moveRelationship.moveToObject
** Type: object
** Description: return data of moveToObject
* moveRelationship.historyData
** Type: object
** Description: return properties {old target identifiers and originTimestamp} after moveRelationship
* moveRelationship.userNode
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
moveRelationship: {
sourceObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
}
},
relationship: {
relType: {
serviceTag: 'xxxx',
relationshipTag: 'rel'
},
relationshipProperties: { originTimestamp: 1234567890 }
},
moveToObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: { }
},
historyData: {
relationshipProperties: { }
},
userNode: {
objTypes: [{ serviceTag: 'UserAccount', objectType: 'user' }],
objInstanceFull: { }
}
}
},
requestParam: {
}
}
status: "complete" // or error,
errorsFound: [],
graphServiceTag: 'GraphHandler'
}

</syntaxhighlight>

== MoveNodeProperties ==
=== Request Parameters ===
* sourceObject
** type: object
** required : true
* targetIdentifiers
** type : object
** required : true
* moveProperties
** type : array
** required : true // index minimum = 1
* updateProperties
** type : object
** required : true
* movePropertiesConditions
** type : array
** required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
sourceObject: {
objType: { },
identifier: { }
},
targetIdentifiers: { },
moveProperties: [ ],
updateProperties: { },
movePropertiesConditions: [ // optional
{
checkObject: 'target', // "source" | "target"
onSetObject: 'target', // "source" | "target"
onPassValue: true,
onNotPassCondition: false, // optional
fieldNameConditions: [ ]
}
]
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.moveNodeProperties
** Type: object
* moveNodeProperties.sourceObject
** Type: object
** Description: return data of sourceObject
* moveRelationship.moveFieldToObject
** Type: string
** Description: return data after moveFieldToObject
* moveRelationship.movedFields
** Type: object
** Description: return data field of moveToObject
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String
=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
moveNodeProperties: {
sourceObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: {
identifiers: { },
fields: { }
}
},
moveFieldToObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: { },
fields: {

}
},
movedFields: { Fields: { } } //
}
}
},
requestParam: { },
status: 'complete',
errorsFound: [],
graphServiceTag: 'GraphHandler'
}
</syntaxhighlight>
[[Category:Working documents| 2025-03-06]]

2025-03-06 - Graph Handler Docs

2026-06-03T06:15:31Z

Seagame: /* Request Parameters */

= GraphHandler Function =
== CreateNode ==
'''Use Case of CreateNode''' >>> https://izara.io/wiki/index.php/2025-03-27_Graph_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
* setFieldConditionals
** type : array
** Required : optional
* deepPathConditional
** type : array
** Required : optional
* parentFlowId
** type : string
** Required: true
* callingFlowConfig
** Type: object
** Required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType": {
"objectType": string,
"serviceTag": string
},
"objInstanceFull": {
"identifiers": {
// ...identifier
},
"fields": {
// ...fields
}
},
setFieldConditionals: [ // optional default array
{
objType: { },
indexValue: { nameSpace: 'ex-011', systemTextTag: 'Gate-011' }, // index field : value
fieldName: '', // fieldName want to set
passValue: 'false', optional
notPassValue: 'true', //optional
conditionals: [ optional ] // condition check field
}
],
"relationships": [
{
"relType": {
"serviceTag": string,
"relationshipTag": string
},
"relationshipProperties": {
//... key and value of targetIdentifiers
},
"relationshipDirection": string, // "from" | "to"
"targetObjType": {
"serviceTag": string,
"objectType": string
},
"targetIdentifiers": {
//... targetIdentifiers
}
}
],
deepPathConditional: [ // optional default array
{
condition: 'notExist', //
conditionCheck: { // traversal
nodeStructure: {
objType: { },
fields: { }
},
nextPath: {
relationshipStructure: {
relType: { },
relationshipDirection: 'to'
},
nodeStructure: {
objType: { },
fields: { }
}
}
}
}
],
"originTimestamp": number, // timestamp when create
"settings": {
"updatePropertiesOnMatch": boolean // default=false
},
"parentFlowId": "", // required
"callingFlow": string,
"callingFlowProperties": object,
}
</syntaxhighlight>

=== 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.relationships
** Type: array
** Description: data from relationships in targetNode
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* Status
** Type: string
** Description: Status from create node. Return "error" or "complete".
* errorsFound
** Type: array
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">

{
returnValue: {
queryResult: {
returnCreateNode: {
objTypes: [
{
serviceTag: "string",
objectType: "string"
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//...fields
}
},
existsNode: { },
userNode: { // // if has userNode send to createNode
objTypes: [
{
"serviceTag": "UserAccount",
"objectType": "user"
}
],
properties: {
//...properties
}
},
relationships: [ // optional : if has requiredOnCreated , createNode with targetNode
{
objTypes: [
{ serviceTag: 'string', objectType: 'string' }
],
objInstanceFull: {
identifiers: {
// identifiers
}
},
relType: {
serviceTag: 'string',
relationshipTag: 'rel'
},
relationshipProperties: {
// properties
}
},
]
}
},
requestParams: {
// return example send param
},
parentFlowId:""
},
status: "string", // "complete' or "error"
errorsFound: [],
graphServiceTag: "GraphHandler"
}

</syntaxhighlight>

== GetNode ==
'''Use Case of GetNode''' >>> https://izara.io/wiki/index.php/2025-04-23_Graph_Use_Case/GetNode_and_GetNodes#Use_Case_GetNodes
=== 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
* versionedDataLabels
** Type: Array
** Required : optional
* settings.updatePropertiesOnMatch
** Type: Boolean
** Required : optional
* parentFlowId
** Type: string
** Required: optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":string,
"objectType":string
},
"objInstanceFull":{
"identifiers":{
// ...identifier
},
"fields":{
// ...fields
}
},
"versionedDataLabels":[
//…versionedData
],
"settings": {
"returnSystemFieldsName" :boolean // default = true or false
},
"parentFlowId" : "" // optional
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* returnValue.queryResult
** Type: object
* queryResult.refactoredNodes
** Type: object
** Description: return object from getNode
* refactoredNodes.objTypes
** Type: array
* refactoredNodes.objInstanceFull
** Type: object
* refactoredNodes.objInstanceFull.identifiers
** Type: object
* refactoredNodes.objInstanceFull.fields
** Type: object
* refactoredNodes.versionDataSystemFields
** Type: object
* refactoredNodes.versionDataSystemFields.versionedDataLabel
** Type: object
* queryResult.requestParam
** Type: object
** Description: return example send param
* errorsFound
** Type: string
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
refactoredNodes: {
objTypes: [
{
serviceTag: "string",
objectType: "string",
}
],
objInstanceFull: {
identifiers: {
//… identifier
},
fields: {
//…fields
}
},
versionDataSystemFields: {
versionedDataLabel: {
originTimestamp: number,
forMatchedId: "string",
versionedDataId: "string"
}
}
}
},
requestParam: {
// return example send param
}
},
errorsFound: [],
graphServiceTag: ''
}
</syntaxhighlight>

== GetNodes ==
'''Use Case of GetNodes''' >>> https://izara.io/wiki/index.php/2025-04-23_Graph_Use_Case/GetNode_and_GetNodes#Use_Case_GetNodes
=== Request Parameters ===
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* fields
** Type : object
** Required: true
* versionedDataLabels
** Type: Array
** Required : optional
* settings.returnSystemFieldsName
** Type: Boolean
** Required : optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":string,
"objectType":string
},
"fields":{
//…fields with matching value
},
"versionedDataLabels":[
//…versionedDataLabels
],
"settings":{
"returnSystemFieldsName":boolean // default=false
},
"parentFlowId" :"" // optional
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResults
** Type: object
* queryResults.getNodesReturnValues
** Type: array
* getNodesReturnValues.objTypes
** Type: array
* getNodesReturnValues.objInstanceFull
** Type: object
* getNodesReturnValues.objInstanceFull.identifiers
** Type: object
* getNodesReturnValues.objInstanceFull.fields
** Type: object
* getNodesReturnValues.versionDataSystemFields
** Type: object
* getNodesReturnValues.versionDataSystemFields.versionedDataLabel
** Type: object
* requestParams
** Type: object
* errorsFound
** Type: string
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: {
getNodesReturnValues: [
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//.. all fields-1
}
},
versionDataSystemFields: {}
},
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//...all fields-2
}
},
versionDataSystemFields: {
versionedDataLabel: {
originTimestamp: number,
forMatchedId: 'string',
versionedDataId: 'string'
}
}
}
]
},
requestParams: {
// return example send param
}
}
}
</syntaxhighlight>

== UpdateNode ==
''' Use Case of UpdateNode''' >>> https://izara.io/wiki/index.php/2025-08-03_-_Graph_Use_Case/UpdateNode
=== 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: object
** Required : true
* objInstanceFull.fields
** Type : object
** Required: true
** Description : can not send fields to update mainNode and versionedData together
* versionedDataIds
** Type: object
** Required: optional
* originTimestamp
** Type: number
** Required: true
* settings
** Type: object
** Required: optional
* parentFlowId
** type : string
** Required: true
* callingFlow
** Type: string
** Required: optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType": {
"serviceTag": string,
"objectType": string
},
"objInstanceFull": {
"identifiers": {
//…identifiers
},
"fields": {
//…fields
// can not be send fields of mainNode and versionedData in fields together!
}
},
"versionedDataIds": {},
"originTimestamp": number, //// timestamp when update
"settings": {},
"parentFlowId": ""// required
"callingFlow": string
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* returnValue.queryResult
** Type: object
** Description: data from created node
* queryResult.objTypes
** Type: array
** Description: serviceTag and objectType
* queryResult.objInstanceFull
** Type: object
** Description: identifiers and fields
* queryResult.userId
** Type: object
** Description: data that update from user Account
* queryResult.versionDataSystemFields
** Type: object
** Description: optional return versionedData
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* returnValue.Status
** Type: string
** Description: status from updated node // error or complete
* returnValue.errorsFound
** Type: array
* returnValue.graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifiers
},
fields: {
//...fields
}
},
userId: {
// if have userNode send to updated
},
versionDataSystemFields: {
versionedDataLabel: {
}
}
},
requestParams: {
// return example send param
},
parentFlowId:""
},
status: 'string',//"complete" // "error"
errorsFound: [],
graphServiceTag: 'string'
}
</syntaxhighlight>

== CreateRelationship ==
''' Use Case of CreateRelationship''' >>> https://izara.io/wiki/index.php/2025-08-01_-_Graph_Use_Case/CreateRelationship
=== Request Parameters ===
* firstObject
** Type: object
** Required: true
* secondObject
** Type: object
** Required: true
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* identifiers
** Type: object
** Required : true
* additionalRelationships
** Type: array of object
** Required: optional
* relType
** Type: object
** Required: true
* relationshipDirection
** Type: string
** Required: true
* relationshipProperties
** Type: object
** Required: true
* deepPathConditional
** Type : array
** Required: optional
** Description : using deepPathConditional for check relationship if not exist , can check on firstNode and seconNode or additionalRelationships
* Settings
** Type: object
** Required: true
* settings.updateRelPropsWhenExist
** Type: boolean
** Required: optional
* parentFlowId
** type : string
** Required: true
* callingFlow
** Type: string
** Required: optional
* callingFlowConfig
** Type: object
** Required: optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject": {
"objType": {
"serviceTag": string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"additionalRelationships": [
{
"objType": {
"serviceTag":string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"relType": {
"serviceTag":string,
"relationshipTag":string
},
"relationshipProperties": {
//…properties
},
"relationshipDirection":string ,// “from” , “to”
"deepPathConditional": []
}
]
},
"secondObject": {
"objType": {
"serviceTag":string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"additionalRelationships": [
//…optional
]
},
"relType": {
"serviceTag":string,
"relationshipTag":string
},
"relationshipDirection":string, // “from” , “to”
"relationshipProperties": {
//…properties
},
"deepPathConditional": [ // default []
{
condition: 'notExist',
conditionCheck: {
nodeStructure: {
objType: {

},
fields: { }
},
nextPath: {
relationshipStructure: {
relType: {

},
relationshipDirection: ''
},
nodeStructure: {
objType: {

},
fields: { }
}
}
}
}
]
"settings": {
"reateOnConditionalFail": false // true default = false
"updateRelPropsWhenExist": boolean,
},
"parentFlowId": "", // required
"callingFlow": "xxxx",
"callingFlowProperties": {
"graphServiceName": string
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.relationship
** Type: object
* queryResult.relationship.relType
** Type: object
* queryResult.relationship.relationshipProperties
** Type: object
* queryResult.firstNode
** Type: object
** Description: return data structure from firstNode
* queryResult.secondNode
** Type: object
** Description: return data structure from secondNode
* queryResult..onCreateAddRelationships
** Type: array
** Description: return data structure from onCreateAddRelationships
* returnValue.firstObject
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* Status
** Type: string
** Description: status from create node // error or complete
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
relationship: {
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//…properties
}
},
firstNode: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: { //… identifiers },
fields: {
//… all fields
}
},
onCreateAddRelationships: [
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//… identifiers
},
fields: {
//… all fields
}
},
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//… all properties
}
}
]
},
secondNode: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: { //… identifiers },
fields: {
//… all fields
}
},
onCreateAddRelationships: [
//… optional
]
}
}
}
}
requestParams: {
// return example send param

},
parentFlowId: "",
Status: 'string', //“complete” // “error”
errorsFound: []
}
}
</syntaxhighlight>

== GetRelationship ==
=== Request Parameters ===
* firstObject
** Type: object
** Required: optional
* secondObject
** Type: object
** Required: optional
* objType
** Type: object
** Required: true
** Description: has serviceTag and objectType
* identifiers
** Type: object
** Required: true
* relType
** Type: object
** Required: true
** Description: has relationshipTag and serviceTag
* relId
** Type: string
** Required: true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag":string,
"objectType":string
},
"identifiers":{
//…identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"relType":{ // required
"relationshipTag": string,
"serviceTag": string
},
"relId": 'string' // // required
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
* Type: object
* queryResult.relType
** Type: object
* queryResult.relationshipProperties
** Type: object
** Description: return relId and properties
* returnValue.toObject
** Type: object
** Description: return toObject if not send secondObject from param
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* errorsFound
** Type: array
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: {
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//…properties : 'string’
}
},
toObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: {
identifiers: {
//
},
fields: { }
}
},
requestParams: {
// return example send param
}
}
}

</syntaxhighlight>

== UpdateRelationship ==
=== Request Parameters ===
* firstObject
** Type: object
** Required: optional
* secondObject
** Type: object
** Required: Optional
* objType
** Type: object
** Required: true
** Description: has serviceTag and objectType
* identifiers
** Type: object
** Required: true
* relId
** Type: string
** Required: true
* relType
** Type: object
** Required: true
** Description: has relationshipTag and serviceTag
* relationshipProperties
** Type: object
** Required: true
** Description: send properties that want to update
* relationshipDirection
** Type: string
** Required: optional
* callingFlow
** Type: string
** Required: optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"relId": string,
"relType":{
"serviceTag":string,
"relationshipTag":string
},
"relationshipProperties":{
//… properties that want to update
},
"relationshipDirection": string, // "from" // “to”
"callingFlow": string
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.firstObject And secondObject
** Type: object
** Description : return objType {seviceTag and objectType} And identifiers
* queryResult.relId
** Type: string
* queryResult.relType
** Type: object
** Description: return {seviceTag and relationshipTag}
* queryResult.relationshipDirection
** Type: string
* queryResult.updatePropertiesParam
** Type: object
** Description: return properties to updated
* queryResult.oldRelationshipProperties
** Type: object
** Description: return old properties before update
* queryResult.newRelationshipProperties
** Type: object
** Description: return new properties after updated
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type : string
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
firstObject: {
objType: {
serviceTag: "string",
objectType: "string"
},
identifiers: {
//…identifiers
}
},
secondObject: {
objType: {
serviceTag: "string",
objectType: "string"
},
identifiers: {
//…identifiers
}
},
relId: "string",
relType: {
serviceTag: "string",
relationshipTag: "string"
},
relationshipDirection: "string",
updatePropertiesParam: {
//… properties updated
},
oldRelationshipProperties: {
// … old properties before update
},
newRelationshipProperties: {
//… new properties after updated
}
}
},
requestParams: {
// return example send param
}
status: “string”, // "complete",”error”
errorsFound: []
}
</syntaxhighlight>

== GetNodeAndRelationship ==
=== Request Parameters ===
* sourceObjType
** Required: true
** Description: has serviceTag and objectType
* sourceIdentifiers
** Type: object
** Required: true
* sourceVersionedDataLabels
** Type: object
** Required: optional
* targetRelationships
** Type: Array
** Required: true
* relTypeAndDirection
** Type: object
** Required: true
* relTypeAndDirection.relType
** Type: object
** Required: true
** Description: has serviceTag and relationshipTag
* relTypeAndDirection.relationshipProperties
** Type: object
** Required: optional
* relTypeAndDirection.relationshipDirection
** Type: String
** Required: optional
* targetObjects
** Type: Array
** Required: Optional
* targetObjects.objType
** Type: object
** Required: required if send targetObjects in param
* targetObjects.identifiers
** Type: object
** Required: optional should have objType if identifiers exists
* targetObjects.versionedDataLabels
** Type: object
** Required: optional have objType if versionedDataLabels exists

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"sourceObjType": { // required
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"sourceIdentifiers": {}, // required
"sourceVersionedDataLabels": [], // optional
"targetRelationships": [ //required
{
"relTypeAndDirection": { // required
"relType": {
"serviceTag": "xxxx",
"relationshipTag": "rel"
},
"relationshipProperties": {},//optional
"relationshipDirection": "" // required
},
"targetObjects": [ // optional
{
"objType": {
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"identifiers": {}, // optional
"versionedDataLabels": [] // optional have objType if versionedDataLabels exists
}
]
},
// if have multiple relTypeAndDirection
],
"settings": {} // defaulf = false >>> if have versionedDataLabels want to return all field of versionedata: settings = { returnSystemFieldsName: true }
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.objTypes
** Type: array of object
** Description: return {serviceTag and objectType}
* queryResult.objInstanceFull
** Type: object
** Description: return {identifiers and fields}
* queryResult.relNodes:
** Type: array
* relNodes.relType
** Type: object
** Description: return {serviceTag and relationshipTag}
* relNodes.relationshipProperties
** Type: object
* relNodes.objTypes
** Type: array of object
** Description: return {serviceTag and objectType}
* relNodes.objInstanceFull
** Type: object
** Description: return {identifiers and fields}
* requestParams
** Type: object
** Description: return same requestParams
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: {},
fields: { }
},
relNodes: [
{
relType: {
serviceTag: 'xxxx',
relationshipTag: 'rel'
},
relationshipProperties: { },
objTypes: [
{
serviceTag: 'xxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: {},
fields: {
// field
}
},
versionDataSystemFields: {
'0VersionDataLabel': {
originTimestamp:
forMatchedId:
versionedDataId:
}
}
}
]
}
},
requestParam : {
// return example send param
},
errorsFound: [],
graphServiceTag: "GraphHandler"
}

</syntaxhighlight>

== ChangeRelationshipType ==
=== Request Parameters ===
* firstObject
** Type : object
** Required : true
* secondObject
** Type : object
** Required : true
* objType
** Type : object
** Required : true
* Identifiers
** Type : object
** Required : true
* oldRelTypeAndDirection
** Type : object
** Required : true
* oldRelTypeAndDirection.relType
** Type : object
** Required : true
* oldRelTypeAndDirection.relationshipDirection
** Type : string
** Required : true
* oldRelTypeAndDirection.relationshipProperties
** Type : object
** Required : optional
* newRelType
** Type : object
** Required : true
* originTimestamp
** Type : number
** Required : true
* changedByUserId
** Type : String
** Required : true
* callingFlow
** Type : String
** Required : optional
* settings
** Type : object
** Required : optional
** Description : default > settings.changeMultipleRelationships : false // if send settings.changeMultipleRelationships : true >> can change multiple relType

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"secondObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"oldRelTypeAndDirection":{
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"old"
},
"relationshipDirection":"from",
"relationshipProperties":{
//Properties
}
},
"newRelType":{
"serviceTag":"xxxx",
"relationshipTag":"new"
},
"originTimestamp":1234567890,
"changedByUserId":"xxxx",
"callingFlow":"yyyy",
"settings":{
"changeMultipleRelationships": boolean: // default false
}
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.newRelationshipType
** Type: object
* newRelationshipType.relType
** Type: object
* newRelationshipType.relationshipDirection
** Type: string
* newRelationshipType.relationshipProperties
** Type: object
* queryResult.oldRelationshipType
** Type: object
* oldRelationshipType.relType
** Type: object
* oldRelationshipType.relationshipDirection
** Type: string
* oldRelationshipType.relationshipProperties
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
newRelationshipType: {
relType: {
serviceTag: "xxxx",
relationshipTag: "new"
},
relationshipDirection: "" // 'from' or 'to'
relationshipProperties: {}
},
oldRelationshipType: {
relType: {
serviceTag: "xxxx",
relationshipTag: "old"
},
relationshipDirection: "" // 'from' or 'to'
relationshipProperties: {}
}
},
requestParams : {
// return example send param
}
},
status: "complete" // or error,
errorsFound: [],
graphServiceTag : 'GraphHandeler'
}

</syntaxhighlight>

== DeleteRelationship ==
=== Request Parameters ===
* fromObject
** Type : object
** Required : optional
* secondObject
** Type : object
** Required : optional
* objType
** Type : object
** Required : true
* Identifiers
** Type : object
** Required : true
* relType
** Type : object
** Required : true
* relId
** Type: string
** Required : true
* relationshipDirection
** Type: string
** Required : optional
* callingFlow
** Type: string
** Required : true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"yyyy"
},
"relId":"string"
},
"relationshipDirection":"string"// "from" or "to"
"callingFlow":"string"
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.objects
** Type: array
* queryResult.objTypes
** Type: array
* queryResult.objInstanceFull.identifiers
** Type: object
* queryResult.objInstanceFull.fields
** Type: object
** Description: return data of fromObject and secondObject
* queryResult.userNode
** Type: object
** Description: return data of userNode
* queryResult.resultDeleteRel
** Type : string
** Description: return status Relationship Delete
* requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objects: [
{
objTypes: [
{
serviceTag: "xxxx",
objectType: "yyyy"
}
],
objInstanceFull: {
identifiers: {
// identifiers
},
fields: {
// fields
}
}
},
{
// if have multiple object objTypes
}
],
userNode: {
objTypes: [
{
serviceTag: "UserAccount",
objectType: "user"
}
],
objInstanceFull: {
identifiers: {
userId: "zzz"
}
}
},
resultDeleteRel: "Relationship Deleted" // default
},
requeatParam: {
// return example send param
},
status: "string", //default "complete" or "error"
errorsFound: []
}
}

</syntaxhighlight>

== DeleteNode ==
=== Request Parameters ===
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* identifiers
** Type : object
** Required: true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":"xxx",
"objectType":"yyy"
},
"identifiers":{
//
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResults
** Type: object
* queryResults.resultDeleteNode
** Type: Boolean
** Description: return status deleted node >> true or false
* requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
** Description: return status deleted node >> complete or error
* errorsFound
** Type: array
* graphServiceTag
** Type: string
=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: { resultDeleteNode: true }, // true or false
requestParams: {
// return example send param
}
},
status: 'string', // 'complete' or 'error'
errorsFound: [],
graphServiceTag: 'GraphHandler'
}
</syntaxhighlight>

== MoveRelationship ==

=== Request Parameters ===
* sourceObject
** Type : object
** Required : true
** Description: required objType: {serviceTag , objectType} and identifiers
* targetObjType
** Type : object
** Required : true
** Description: required objType: {serviceTag , objectType}
* relType
** Type : object
** Required : true
** Description: required objType: {serviceTag , relationshipTag}
* relationshipDirection
** Type : object
** Required : true
* moveToIdentifiers
** Type : object
** Required : true
* moveByUserId
** Type : String
** Required : true
* originTimestamp
** Type : number
** Required : true
* settings
** Type : object
** Required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"sourceObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyy"
},
"identifiers":{
// identifiers
}
},
"targetObjType":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
}
},
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"rel"
},
"relationshipDirection":"from", // "to"
"moveToIdentifiers":{
// target identifiers
},
"moveByUserId":"xxxx",
"originTimestamp":1234567890,
"settings":{}
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.moveRelationship
** Type: object
* moveRelationship.sourceObject
** Type: object
** Description: return data of sourceObject
* moveRelationship.relationship
** Type: string
** Description: return data of after move relationship
* moveRelationship.moveToObject
** Type: object
** Description: return data of moveToObject
* moveRelationship.historyData
** Type: object
** Description: return properties {old target identifiers and originTimestamp} after moveRelationship
* moveRelationship.userNode
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
moveRelationship: {
sourceObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
}
},
relationship: {
relType: {
serviceTag: 'xxxx',
relationshipTag: 'rel'
},
relationshipProperties: { originTimestamp: 1234567890 }
},
moveToObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: { }
},
historyData: {
relationshipProperties: { }
},
userNode: {
objTypes: [{ serviceTag: 'UserAccount', objectType: 'user' }],
objInstanceFull: { }
}
}
},
requestParam: {
}
}
status: "complete" // or error,
errorsFound: [],
graphServiceTag: 'GraphHandler'
}

</syntaxhighlight>

== MoveNodeProperties ==
=== Request Parameters ===
* sourceObject
** type: object
** required : true
* targetIdentifiers
** type : object
** required : true
* moveProperties
** type : array
** required : true // index minimum = 1
* updateProperties
** type : object
** required : true
* movePropertiesConditions
** type : array
** required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
sourceObject: {
objType: { },
identifier: { }
},
targetIdentifiers: { },
moveProperties: [ ],
updateProperties: { },
movePropertiesConditions: [ // optional
{
checkObject: 'target', // "source" | "target"
onSetObject: 'target', // "source" | "target"
onPassValue: true,
onNotPassCondition: false, // optional
fieldNameConditions: [ ]
}
]
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.moveNodeProperties
** Type: object
* moveNodeProperties.sourceObject
** Type: object
** Description: return data of sourceObject
* moveRelationship.moveFieldToObject
** Type: string
** Description: return data after moveFieldToObject
* moveRelationship.movedFields
** Type: object
** Description: return data field of moveToObject
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String
=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
moveNodeProperties: {
sourceObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: {
identifiers: { },
fields: { }
}
},
moveFieldToObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: { },
fields: {

}
},
movedFields: { Fields: { } } //
}
}
},
requestParam: { },
status: 'complete',
errorsFound: [],
graphServiceTag: 'GraphHandler'
}
</syntaxhighlight>
[[Category:Working documents| 2025-03-06]]

2025-03-06 - Graph Handler Docs

2026-06-03T06:10:46Z

Seagame: /* Request Example */

= GraphHandler Function =
== CreateNode ==
'''Use Case of CreateNode''' >>> https://izara.io/wiki/index.php/2025-03-27_Graph_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
* setFieldConditionals
** type : array
** Required : optional
* deepPathConditional
** type : array
** Required : optional
* parentFlowId
** type : string
** Required: true
* callingFlowConfig
** Type: object
** Required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType": {
"objectType": string,
"serviceTag": string
},
"objInstanceFull": {
"identifiers": {
// ...identifier
},
"fields": {
// ...fields
}
},
setFieldConditionals: [ // optional default array
{
objType: { },
indexValue: { nameSpace: 'ex-011', systemTextTag: 'Gate-011' }, // index field : value
fieldName: '', // fieldName want to set
passValue: 'false', optional
notPassValue: 'true', //optional
conditionals: [ optional ] // condition check field
}
],
"relationships": [
{
"relType": {
"serviceTag": string,
"relationshipTag": string
},
"relationshipProperties": {
//... key and value of targetIdentifiers
},
"relationshipDirection": string, // "from" | "to"
"targetObjType": {
"serviceTag": string,
"objectType": string
},
"targetIdentifiers": {
//... targetIdentifiers
}
}
],
deepPathConditional: [ // optional default array
{
condition: 'notExist', //
conditionCheck: { // traversal
nodeStructure: {
objType: { },
fields: { }
},
nextPath: {
relationshipStructure: {
relType: { },
relationshipDirection: 'to'
},
nodeStructure: {
objType: { },
fields: { }
}
}
}
}
],
"originTimestamp": number, // timestamp when create
"settings": {
"updatePropertiesOnMatch": boolean // default=false
},
"parentFlowId": "", // required
"callingFlow": string,
"callingFlowProperties": object,
}
</syntaxhighlight>

=== 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.relationships
** Type: array
** Description: data from relationships in targetNode
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* Status
** Type: string
** Description: Status from create node. Return "error" or "complete".
* errorsFound
** Type: array
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">

{
returnValue: {
queryResult: {
returnCreateNode: {
objTypes: [
{
serviceTag: "string",
objectType: "string"
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//...fields
}
},
existsNode: { },
userNode: { // // if has userNode send to createNode
objTypes: [
{
"serviceTag": "UserAccount",
"objectType": "user"
}
],
properties: {
//...properties
}
},
relationships: [ // optional : if has requiredOnCreated , createNode with targetNode
{
objTypes: [
{ serviceTag: 'string', objectType: 'string' }
],
objInstanceFull: {
identifiers: {
// identifiers
}
},
relType: {
serviceTag: 'string',
relationshipTag: 'rel'
},
relationshipProperties: {
// properties
}
},
]
}
},
requestParams: {
// return example send param
},
parentFlowId:""
},
status: "string", // "complete' or "error"
errorsFound: [],
graphServiceTag: "GraphHandler"
}

</syntaxhighlight>

== GetNode ==
'''Use Case of GetNode''' >>> https://izara.io/wiki/index.php/2025-04-23_Graph_Use_Case/GetNode_and_GetNodes#Use_Case_GetNodes
=== 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
* versionedDataLabels
** Type: Array
** Required : optional
* settings.updatePropertiesOnMatch
** Type: Boolean
** Required : optional
* parentFlowId
** Type: string
** Required: optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":string,
"objectType":string
},
"objInstanceFull":{
"identifiers":{
// ...identifier
},
"fields":{
// ...fields
}
},
"versionedDataLabels":[
//…versionedData
],
"settings": {
"returnSystemFieldsName" :boolean // default = true or false
},
"parentFlowId" : "" // optional
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* returnValue.queryResult
** Type: object
* queryResult.refactoredNodes
** Type: object
** Description: return object from getNode
* refactoredNodes.objTypes
** Type: array
* refactoredNodes.objInstanceFull
** Type: object
* refactoredNodes.objInstanceFull.identifiers
** Type: object
* refactoredNodes.objInstanceFull.fields
** Type: object
* refactoredNodes.versionDataSystemFields
** Type: object
* refactoredNodes.versionDataSystemFields.versionedDataLabel
** Type: object
* queryResult.requestParam
** Type: object
** Description: return example send param
* errorsFound
** Type: string
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
refactoredNodes: {
objTypes: [
{
serviceTag: "string",
objectType: "string",
}
],
objInstanceFull: {
identifiers: {
//… identifier
},
fields: {
//…fields
}
},
versionDataSystemFields: {
versionedDataLabel: {
originTimestamp: number,
forMatchedId: "string",
versionedDataId: "string"
}
}
}
},
requestParam: {
// return example send param
}
},
errorsFound: [],
graphServiceTag: ''
}
</syntaxhighlight>

== GetNodes ==
'''Use Case of GetNodes''' >>> https://izara.io/wiki/index.php/2025-04-23_Graph_Use_Case/GetNode_and_GetNodes#Use_Case_GetNodes
=== Request Parameters ===
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* fields
** Type : object
** Required: true
* versionedDataLabels
** Type: Array
** Required : optional
* settings.returnSystemFieldsName
** Type: Boolean
** Required : optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":string,
"objectType":string
},
"fields":{
//…fields with matching value
},
"versionedDataLabels":[
//…versionedDataLabels
],
"settings":{
"returnSystemFieldsName":boolean // default=false
},
"parentFlowId" :"" // optional
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResults
** Type: object
* queryResults.getNodesReturnValues
** Type: array
* getNodesReturnValues.objTypes
** Type: array
* getNodesReturnValues.objInstanceFull
** Type: object
* getNodesReturnValues.objInstanceFull.identifiers
** Type: object
* getNodesReturnValues.objInstanceFull.fields
** Type: object
* getNodesReturnValues.versionDataSystemFields
** Type: object
* getNodesReturnValues.versionDataSystemFields.versionedDataLabel
** Type: object
* requestParams
** Type: object
* errorsFound
** Type: string
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: {
getNodesReturnValues: [
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//.. all fields-1
}
},
versionDataSystemFields: {}
},
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//...all fields-2
}
},
versionDataSystemFields: {
versionedDataLabel: {
originTimestamp: number,
forMatchedId: 'string',
versionedDataId: 'string'
}
}
}
]
},
requestParams: {
// return example send param
}
}
}
</syntaxhighlight>

== UpdateNode ==
''' Use Case of UpdateNode''' >>> https://izara.io/wiki/index.php/2025-08-03_-_Graph_Use_Case/UpdateNode
=== 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: object
** Required : true
* objInstanceFull.fields
** Type : object
** Required: true
** Description : can not send fields to update mainNode and versionedData together
* versionedDataIds
** Type: object
** Required: optional
* originTimestamp
** Type: number
** Required: true
* settings
** Type: object
** Required: optional
* parentFlowId
** type : string
** Required: true
* callingFlow
** Type: string
** Required: optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType": {
"serviceTag": string,
"objectType": string
},
"objInstanceFull": {
"identifiers": {
//…identifiers
},
"fields": {
//…fields
// can not be send fields of mainNode and versionedData in fields together!
}
},
"versionedDataIds": {},
"originTimestamp": number, //// timestamp when update
"settings": {},
"parentFlowId": ""// required
"callingFlow": string
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* returnValue.queryResult
** Type: object
** Description: data from created node
* queryResult.objTypes
** Type: array
** Description: serviceTag and objectType
* queryResult.objInstanceFull
** Type: object
** Description: identifiers and fields
* queryResult.userId
** Type: object
** Description: data that update from user Account
* queryResult.versionDataSystemFields
** Type: object
** Description: optional return versionedData
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* returnValue.Status
** Type: string
** Description: status from updated node // error or complete
* returnValue.errorsFound
** Type: array
* returnValue.graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifiers
},
fields: {
//...fields
}
},
userId: {
// if have userNode send to updated
},
versionDataSystemFields: {
versionedDataLabel: {
}
}
},
requestParams: {
// return example send param
},
parentFlowId:""
},
status: 'string',//"complete" // "error"
errorsFound: [],
graphServiceTag: 'string'
}
</syntaxhighlight>

== CreateRelationship ==
''' Use Case of CreateRelationship''' >>> https://izara.io/wiki/index.php/2025-08-01_-_Graph_Use_Case/CreateRelationship
=== Request Parameters ===
* firstObject
** Type: object
** Required: true
* secondObject
** Type: object
** Required: true
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* identifiers
** Type: object
** Required : true
* createRelationshipIfNothave
** Type : array
** Required: optional
** Description : using createRelationshipIfNothave for check relationship if not has created , can check both firstNode and SeconNode or onCreateAddRelationships
* onCreateAddRelationships
** Type: array of object
** Required: optional
* relType
** Type: object
** Required: true
* relationshipDirection
** Type: string
** Required: true
* relationshipProperties
** Type: object
** Required: true
* Settings
** Type: object
** Required: true
* settings.updateRelPropsWhenExist
** Type: boolean
** Required: optional
* parentFlowId
** type : string
** Required: true
* callingFlow
** Type: string
** Required: optional
* callingFlowConfig
** Type: object
** Required: optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject": {
"objType": {
"serviceTag": string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"additionalRelationships": [
{
"objType": {
"serviceTag":string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"relType": {
"serviceTag":string,
"relationshipTag":string
},
"relationshipProperties": {
//…properties
},
"relationshipDirection":string ,// “from” , “to”
"deepPathConditional": []
}
]
},
"secondObject": {
"objType": {
"serviceTag":string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"additionalRelationships": [
//…optional
]
},
"relType": {
"serviceTag":string,
"relationshipTag":string
},
"relationshipDirection":string, // “from” , “to”
"relationshipProperties": {
//…properties
},
"deepPathConditional": [ // default []
{
condition: 'notExist',
conditionCheck: {
nodeStructure: {
objType: {

},
fields: { }
},
nextPath: {
relationshipStructure: {
relType: {

},
relationshipDirection: ''
},
nodeStructure: {
objType: {

},
fields: { }
}
}
}
}
]
"settings": {
"reateOnConditionalFail": false // true default = false
"updateRelPropsWhenExist": boolean,
},
"parentFlowId": "", // required
"callingFlow": "xxxx",
"callingFlowProperties": {
"graphServiceName": string
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.relationship
** Type: object
* queryResult.relationship.relType
** Type: object
* queryResult.relationship.relationshipProperties
** Type: object
* queryResult.firstNode
** Type: object
** Description: return data structure from firstNode
* queryResult.secondNode
** Type: object
** Description: return data structure from secondNode
* queryResult..onCreateAddRelationships
** Type: array
** Description: return data structure from onCreateAddRelationships
* returnValue.firstObject
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* Status
** Type: string
** Description: status from create node // error or complete
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
relationship: {
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//…properties
}
},
firstNode: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: { //… identifiers },
fields: {
//… all fields
}
},
onCreateAddRelationships: [
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//… identifiers
},
fields: {
//… all fields
}
},
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//… all properties
}
}
]
},
secondNode: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: { //… identifiers },
fields: {
//… all fields
}
},
onCreateAddRelationships: [
//… optional
]
}
}
}
}
requestParams: {
// return example send param

},
parentFlowId: "",
Status: 'string', //“complete” // “error”
errorsFound: []
}
}
</syntaxhighlight>

== GetRelationship ==
=== Request Parameters ===
* firstObject
** Type: object
** Required: optional
* secondObject
** Type: object
** Required: optional
* objType
** Type: object
** Required: true
** Description: has serviceTag and objectType
* identifiers
** Type: object
** Required: true
* relType
** Type: object
** Required: true
** Description: has relationshipTag and serviceTag
* relId
** Type: string
** Required: true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag":string,
"objectType":string
},
"identifiers":{
//…identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"relType":{ // required
"relationshipTag": string,
"serviceTag": string
},
"relId": 'string' // // required
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
* Type: object
* queryResult.relType
** Type: object
* queryResult.relationshipProperties
** Type: object
** Description: return relId and properties
* returnValue.toObject
** Type: object
** Description: return toObject if not send secondObject from param
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* errorsFound
** Type: array
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: {
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//…properties : 'string’
}
},
toObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: {
identifiers: {
//
},
fields: { }
}
},
requestParams: {
// return example send param
}
}
}

</syntaxhighlight>

== UpdateRelationship ==
=== Request Parameters ===
* firstObject
** Type: object
** Required: optional
* secondObject
** Type: object
** Required: Optional
* objType
** Type: object
** Required: true
** Description: has serviceTag and objectType
* identifiers
** Type: object
** Required: true
* relId
** Type: string
** Required: true
* relType
** Type: object
** Required: true
** Description: has relationshipTag and serviceTag
* relationshipProperties
** Type: object
** Required: true
** Description: send properties that want to update
* relationshipDirection
** Type: string
** Required: optional
* callingFlow
** Type: string
** Required: optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"relId": string,
"relType":{
"serviceTag":string,
"relationshipTag":string
},
"relationshipProperties":{
//… properties that want to update
},
"relationshipDirection": string, // "from" // “to”
"callingFlow": string
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.firstObject And secondObject
** Type: object
** Description : return objType {seviceTag and objectType} And identifiers
* queryResult.relId
** Type: string
* queryResult.relType
** Type: object
** Description: return {seviceTag and relationshipTag}
* queryResult.relationshipDirection
** Type: string
* queryResult.updatePropertiesParam
** Type: object
** Description: return properties to updated
* queryResult.oldRelationshipProperties
** Type: object
** Description: return old properties before update
* queryResult.newRelationshipProperties
** Type: object
** Description: return new properties after updated
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type : string
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
firstObject: {
objType: {
serviceTag: "string",
objectType: "string"
},
identifiers: {
//…identifiers
}
},
secondObject: {
objType: {
serviceTag: "string",
objectType: "string"
},
identifiers: {
//…identifiers
}
},
relId: "string",
relType: {
serviceTag: "string",
relationshipTag: "string"
},
relationshipDirection: "string",
updatePropertiesParam: {
//… properties updated
},
oldRelationshipProperties: {
// … old properties before update
},
newRelationshipProperties: {
//… new properties after updated
}
}
},
requestParams: {
// return example send param
}
status: “string”, // "complete",”error”
errorsFound: []
}
</syntaxhighlight>

== GetNodeAndRelationship ==
=== Request Parameters ===
* sourceObjType
** Required: true
** Description: has serviceTag and objectType
* sourceIdentifiers
** Type: object
** Required: true
* sourceVersionedDataLabels
** Type: object
** Required: optional
* targetRelationships
** Type: Array
** Required: true
* relTypeAndDirection
** Type: object
** Required: true
* relTypeAndDirection.relType
** Type: object
** Required: true
** Description: has serviceTag and relationshipTag
* relTypeAndDirection.relationshipProperties
** Type: object
** Required: optional
* relTypeAndDirection.relationshipDirection
** Type: String
** Required: optional
* targetObjects
** Type: Array
** Required: Optional
* targetObjects.objType
** Type: object
** Required: required if send targetObjects in param
* targetObjects.identifiers
** Type: object
** Required: optional should have objType if identifiers exists
* targetObjects.versionedDataLabels
** Type: object
** Required: optional have objType if versionedDataLabels exists

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"sourceObjType": { // required
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"sourceIdentifiers": {}, // required
"sourceVersionedDataLabels": [], // optional
"targetRelationships": [ //required
{
"relTypeAndDirection": { // required
"relType": {
"serviceTag": "xxxx",
"relationshipTag": "rel"
},
"relationshipProperties": {},//optional
"relationshipDirection": "" // required
},
"targetObjects": [ // optional
{
"objType": {
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"identifiers": {}, // optional
"versionedDataLabels": [] // optional have objType if versionedDataLabels exists
}
]
},
// if have multiple relTypeAndDirection
],
"settings": {} // defaulf = false >>> if have versionedDataLabels want to return all field of versionedata: settings = { returnSystemFieldsName: true }
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.objTypes
** Type: array of object
** Description: return {serviceTag and objectType}
* queryResult.objInstanceFull
** Type: object
** Description: return {identifiers and fields}
* queryResult.relNodes:
** Type: array
* relNodes.relType
** Type: object
** Description: return {serviceTag and relationshipTag}
* relNodes.relationshipProperties
** Type: object
* relNodes.objTypes
** Type: array of object
** Description: return {serviceTag and objectType}
* relNodes.objInstanceFull
** Type: object
** Description: return {identifiers and fields}
* requestParams
** Type: object
** Description: return same requestParams
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: {},
fields: { }
},
relNodes: [
{
relType: {
serviceTag: 'xxxx',
relationshipTag: 'rel'
},
relationshipProperties: { },
objTypes: [
{
serviceTag: 'xxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: {},
fields: {
// field
}
},
versionDataSystemFields: {
'0VersionDataLabel': {
originTimestamp:
forMatchedId:
versionedDataId:
}
}
}
]
}
},
requestParam : {
// return example send param
},
errorsFound: [],
graphServiceTag: "GraphHandler"
}

</syntaxhighlight>

== ChangeRelationshipType ==
=== Request Parameters ===
* firstObject
** Type : object
** Required : true
* secondObject
** Type : object
** Required : true
* objType
** Type : object
** Required : true
* Identifiers
** Type : object
** Required : true
* oldRelTypeAndDirection
** Type : object
** Required : true
* oldRelTypeAndDirection.relType
** Type : object
** Required : true
* oldRelTypeAndDirection.relationshipDirection
** Type : string
** Required : true
* oldRelTypeAndDirection.relationshipProperties
** Type : object
** Required : optional
* newRelType
** Type : object
** Required : true
* originTimestamp
** Type : number
** Required : true
* changedByUserId
** Type : String
** Required : true
* callingFlow
** Type : String
** Required : optional
* settings
** Type : object
** Required : optional
** Description : default > settings.changeMultipleRelationships : false // if send settings.changeMultipleRelationships : true >> can change multiple relType

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"secondObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"oldRelTypeAndDirection":{
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"old"
},
"relationshipDirection":"from",
"relationshipProperties":{
//Properties
}
},
"newRelType":{
"serviceTag":"xxxx",
"relationshipTag":"new"
},
"originTimestamp":1234567890,
"changedByUserId":"xxxx",
"callingFlow":"yyyy",
"settings":{
"changeMultipleRelationships": boolean: // default false
}
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.newRelationshipType
** Type: object
* newRelationshipType.relType
** Type: object
* newRelationshipType.relationshipDirection
** Type: string
* newRelationshipType.relationshipProperties
** Type: object
* queryResult.oldRelationshipType
** Type: object
* oldRelationshipType.relType
** Type: object
* oldRelationshipType.relationshipDirection
** Type: string
* oldRelationshipType.relationshipProperties
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
newRelationshipType: {
relType: {
serviceTag: "xxxx",
relationshipTag: "new"
},
relationshipDirection: "" // 'from' or 'to'
relationshipProperties: {}
},
oldRelationshipType: {
relType: {
serviceTag: "xxxx",
relationshipTag: "old"
},
relationshipDirection: "" // 'from' or 'to'
relationshipProperties: {}
}
},
requestParams : {
// return example send param
}
},
status: "complete" // or error,
errorsFound: [],
graphServiceTag : 'GraphHandeler'
}

</syntaxhighlight>

== DeleteRelationship ==
=== Request Parameters ===
* fromObject
** Type : object
** Required : optional
* secondObject
** Type : object
** Required : optional
* objType
** Type : object
** Required : true
* Identifiers
** Type : object
** Required : true
* relType
** Type : object
** Required : true
* relId
** Type: string
** Required : true
* relationshipDirection
** Type: string
** Required : optional
* callingFlow
** Type: string
** Required : true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"yyyy"
},
"relId":"string"
},
"relationshipDirection":"string"// "from" or "to"
"callingFlow":"string"
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.objects
** Type: array
* queryResult.objTypes
** Type: array
* queryResult.objInstanceFull.identifiers
** Type: object
* queryResult.objInstanceFull.fields
** Type: object
** Description: return data of fromObject and secondObject
* queryResult.userNode
** Type: object
** Description: return data of userNode
* queryResult.resultDeleteRel
** Type : string
** Description: return status Relationship Delete
* requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objects: [
{
objTypes: [
{
serviceTag: "xxxx",
objectType: "yyyy"
}
],
objInstanceFull: {
identifiers: {
// identifiers
},
fields: {
// fields
}
}
},
{
// if have multiple object objTypes
}
],
userNode: {
objTypes: [
{
serviceTag: "UserAccount",
objectType: "user"
}
],
objInstanceFull: {
identifiers: {
userId: "zzz"
}
}
},
resultDeleteRel: "Relationship Deleted" // default
},
requeatParam: {
// return example send param
},
status: "string", //default "complete" or "error"
errorsFound: []
}
}

</syntaxhighlight>

== DeleteNode ==
=== Request Parameters ===
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* identifiers
** Type : object
** Required: true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":"xxx",
"objectType":"yyy"
},
"identifiers":{
//
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResults
** Type: object
* queryResults.resultDeleteNode
** Type: Boolean
** Description: return status deleted node >> true or false
* requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
** Description: return status deleted node >> complete or error
* errorsFound
** Type: array
* graphServiceTag
** Type: string
=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: { resultDeleteNode: true }, // true or false
requestParams: {
// return example send param
}
},
status: 'string', // 'complete' or 'error'
errorsFound: [],
graphServiceTag: 'GraphHandler'
}
</syntaxhighlight>

== MoveRelationship ==

=== Request Parameters ===
* sourceObject
** Type : object
** Required : true
** Description: required objType: {serviceTag , objectType} and identifiers
* targetObjType
** Type : object
** Required : true
** Description: required objType: {serviceTag , objectType}
* relType
** Type : object
** Required : true
** Description: required objType: {serviceTag , relationshipTag}
* relationshipDirection
** Type : object
** Required : true
* moveToIdentifiers
** Type : object
** Required : true
* moveByUserId
** Type : String
** Required : true
* originTimestamp
** Type : number
** Required : true
* settings
** Type : object
** Required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"sourceObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyy"
},
"identifiers":{
// identifiers
}
},
"targetObjType":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
}
},
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"rel"
},
"relationshipDirection":"from", // "to"
"moveToIdentifiers":{
// target identifiers
},
"moveByUserId":"xxxx",
"originTimestamp":1234567890,
"settings":{}
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.moveRelationship
** Type: object
* moveRelationship.sourceObject
** Type: object
** Description: return data of sourceObject
* moveRelationship.relationship
** Type: string
** Description: return data of after move relationship
* moveRelationship.moveToObject
** Type: object
** Description: return data of moveToObject
* moveRelationship.historyData
** Type: object
** Description: return properties {old target identifiers and originTimestamp} after moveRelationship
* moveRelationship.userNode
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
moveRelationship: {
sourceObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
}
},
relationship: {
relType: {
serviceTag: 'xxxx',
relationshipTag: 'rel'
},
relationshipProperties: { originTimestamp: 1234567890 }
},
moveToObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: { }
},
historyData: {
relationshipProperties: { }
},
userNode: {
objTypes: [{ serviceTag: 'UserAccount', objectType: 'user' }],
objInstanceFull: { }
}
}
},
requestParam: {
}
}
status: "complete" // or error,
errorsFound: [],
graphServiceTag: 'GraphHandler'
}

</syntaxhighlight>

== MoveNodeProperties ==
=== Request Parameters ===
* sourceObject
** type: object
** required : true
* targetIdentifiers
** type : object
** required : true
* moveProperties
** type : array
** required : true // index minimum = 1
* updateProperties
** type : object
** required : true
* movePropertiesConditions
** type : array
** required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
sourceObject: {
objType: { },
identifier: { }
},
targetIdentifiers: { },
moveProperties: [ ],
updateProperties: { },
movePropertiesConditions: [ // optional
{
checkObject: 'target', // "source" | "target"
onSetObject: 'target', // "source" | "target"
onPassValue: true,
onNotPassCondition: false, // optional
fieldNameConditions: [ ]
}
]
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.moveNodeProperties
** Type: object
* moveNodeProperties.sourceObject
** Type: object
** Description: return data of sourceObject
* moveRelationship.moveFieldToObject
** Type: string
** Description: return data after moveFieldToObject
* moveRelationship.movedFields
** Type: object
** Description: return data field of moveToObject
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String
=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
moveNodeProperties: {
sourceObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: {
identifiers: { },
fields: { }
}
},
moveFieldToObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: { },
fields: {

}
},
movedFields: { Fields: { } } //
}
}
},
requestParam: { },
status: 'complete',
errorsFound: [],
graphServiceTag: 'GraphHandler'
}
</syntaxhighlight>
[[Category:Working documents| 2025-03-06]]

2025-03-06 - Graph Handler Docs

2026-06-03T06:07:28Z

Seagame: /* CreateRelationship */

= GraphHandler Function =
== CreateNode ==
'''Use Case of CreateNode''' >>> https://izara.io/wiki/index.php/2025-03-27_Graph_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
* setFieldConditionals
** type : array
** Required : optional
* deepPathConditional
** type : array
** Required : optional
* parentFlowId
** type : string
** Required: true
* callingFlowConfig
** Type: object
** Required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType": {
"objectType": string,
"serviceTag": string
},
"objInstanceFull": {
"identifiers": {
// ...identifier
},
"fields": {
// ...fields
}
},
setFieldConditionals: [ // optional default array
{
objType: { },
indexValue: { nameSpace: 'ex-011', systemTextTag: 'Gate-011' }, // index field : value
fieldName: '', // fieldName want to set
passValue: 'false', optional
notPassValue: 'true', //optional
conditionals: [ optional ] // condition check field
}
],
"relationships": [
{
"relType": {
"serviceTag": string,
"relationshipTag": string
},
"relationshipProperties": {
//... key and value of targetIdentifiers
},
"relationshipDirection": string, // "from" | "to"
"targetObjType": {
"serviceTag": string,
"objectType": string
},
"targetIdentifiers": {
//... targetIdentifiers
}
}
],
deepPathConditional: [ // optional default array
{
condition: 'notExist', //
conditionCheck: { // traversal
nodeStructure: {
objType: { },
fields: { }
},
nextPath: {
relationshipStructure: {
relType: { },
relationshipDirection: 'to'
},
nodeStructure: {
objType: { },
fields: { }
}
}
}
}
],
"originTimestamp": number, // timestamp when create
"settings": {
"updatePropertiesOnMatch": boolean // default=false
},
"parentFlowId": "", // required
"callingFlow": string,
"callingFlowProperties": object,
}
</syntaxhighlight>

=== 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.relationships
** Type: array
** Description: data from relationships in targetNode
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* Status
** Type: string
** Description: Status from create node. Return "error" or "complete".
* errorsFound
** Type: array
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">

{
returnValue: {
queryResult: {
returnCreateNode: {
objTypes: [
{
serviceTag: "string",
objectType: "string"
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//...fields
}
},
existsNode: { },
userNode: { // // if has userNode send to createNode
objTypes: [
{
"serviceTag": "UserAccount",
"objectType": "user"
}
],
properties: {
//...properties
}
},
relationships: [ // optional : if has requiredOnCreated , createNode with targetNode
{
objTypes: [
{ serviceTag: 'string', objectType: 'string' }
],
objInstanceFull: {
identifiers: {
// identifiers
}
},
relType: {
serviceTag: 'string',
relationshipTag: 'rel'
},
relationshipProperties: {
// properties
}
},
]
}
},
requestParams: {
// return example send param
},
parentFlowId:""
},
status: "string", // "complete' or "error"
errorsFound: [],
graphServiceTag: "GraphHandler"
}

</syntaxhighlight>

== GetNode ==
'''Use Case of GetNode''' >>> https://izara.io/wiki/index.php/2025-04-23_Graph_Use_Case/GetNode_and_GetNodes#Use_Case_GetNodes
=== 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
* versionedDataLabels
** Type: Array
** Required : optional
* settings.updatePropertiesOnMatch
** Type: Boolean
** Required : optional
* parentFlowId
** Type: string
** Required: optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":string,
"objectType":string
},
"objInstanceFull":{
"identifiers":{
// ...identifier
},
"fields":{
// ...fields
}
},
"versionedDataLabels":[
//…versionedData
],
"settings": {
"returnSystemFieldsName" :boolean // default = true or false
},
"parentFlowId" : "" // optional
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* returnValue.queryResult
** Type: object
* queryResult.refactoredNodes
** Type: object
** Description: return object from getNode
* refactoredNodes.objTypes
** Type: array
* refactoredNodes.objInstanceFull
** Type: object
* refactoredNodes.objInstanceFull.identifiers
** Type: object
* refactoredNodes.objInstanceFull.fields
** Type: object
* refactoredNodes.versionDataSystemFields
** Type: object
* refactoredNodes.versionDataSystemFields.versionedDataLabel
** Type: object
* queryResult.requestParam
** Type: object
** Description: return example send param
* errorsFound
** Type: string
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
refactoredNodes: {
objTypes: [
{
serviceTag: "string",
objectType: "string",
}
],
objInstanceFull: {
identifiers: {
//… identifier
},
fields: {
//…fields
}
},
versionDataSystemFields: {
versionedDataLabel: {
originTimestamp: number,
forMatchedId: "string",
versionedDataId: "string"
}
}
}
},
requestParam: {
// return example send param
}
},
errorsFound: [],
graphServiceTag: ''
}
</syntaxhighlight>

== GetNodes ==
'''Use Case of GetNodes''' >>> https://izara.io/wiki/index.php/2025-04-23_Graph_Use_Case/GetNode_and_GetNodes#Use_Case_GetNodes
=== Request Parameters ===
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* fields
** Type : object
** Required: true
* versionedDataLabels
** Type: Array
** Required : optional
* settings.returnSystemFieldsName
** Type: Boolean
** Required : optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":string,
"objectType":string
},
"fields":{
//…fields with matching value
},
"versionedDataLabels":[
//…versionedDataLabels
],
"settings":{
"returnSystemFieldsName":boolean // default=false
},
"parentFlowId" :"" // optional
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResults
** Type: object
* queryResults.getNodesReturnValues
** Type: array
* getNodesReturnValues.objTypes
** Type: array
* getNodesReturnValues.objInstanceFull
** Type: object
* getNodesReturnValues.objInstanceFull.identifiers
** Type: object
* getNodesReturnValues.objInstanceFull.fields
** Type: object
* getNodesReturnValues.versionDataSystemFields
** Type: object
* getNodesReturnValues.versionDataSystemFields.versionedDataLabel
** Type: object
* requestParams
** Type: object
* errorsFound
** Type: string
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: {
getNodesReturnValues: [
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//.. all fields-1
}
},
versionDataSystemFields: {}
},
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//...all fields-2
}
},
versionDataSystemFields: {
versionedDataLabel: {
originTimestamp: number,
forMatchedId: 'string',
versionedDataId: 'string'
}
}
}
]
},
requestParams: {
// return example send param
}
}
}
</syntaxhighlight>

== UpdateNode ==
''' Use Case of UpdateNode''' >>> https://izara.io/wiki/index.php/2025-08-03_-_Graph_Use_Case/UpdateNode
=== 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: object
** Required : true
* objInstanceFull.fields
** Type : object
** Required: true
** Description : can not send fields to update mainNode and versionedData together
* versionedDataIds
** Type: object
** Required: optional
* originTimestamp
** Type: number
** Required: true
* settings
** Type: object
** Required: optional
* parentFlowId
** type : string
** Required: true
* callingFlow
** Type: string
** Required: optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType": {
"serviceTag": string,
"objectType": string
},
"objInstanceFull": {
"identifiers": {
//…identifiers
},
"fields": {
//…fields
// can not be send fields of mainNode and versionedData in fields together!
}
},
"versionedDataIds": {},
"originTimestamp": number, //// timestamp when update
"settings": {},
"parentFlowId": ""// required
"callingFlow": string
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* returnValue.queryResult
** Type: object
** Description: data from created node
* queryResult.objTypes
** Type: array
** Description: serviceTag and objectType
* queryResult.objInstanceFull
** Type: object
** Description: identifiers and fields
* queryResult.userId
** Type: object
** Description: data that update from user Account
* queryResult.versionDataSystemFields
** Type: object
** Description: optional return versionedData
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* returnValue.Status
** Type: string
** Description: status from updated node // error or complete
* returnValue.errorsFound
** Type: array
* returnValue.graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifiers
},
fields: {
//...fields
}
},
userId: {
// if have userNode send to updated
},
versionDataSystemFields: {
versionedDataLabel: {
}
}
},
requestParams: {
// return example send param
},
parentFlowId:""
},
status: 'string',//"complete" // "error"
errorsFound: [],
graphServiceTag: 'string'
}
</syntaxhighlight>

== CreateRelationship ==
''' Use Case of CreateRelationship''' >>> https://izara.io/wiki/index.php/2025-08-01_-_Graph_Use_Case/CreateRelationship
=== Request Parameters ===
* firstObject
** Type: object
** Required: true
* secondObject
** Type: object
** Required: true
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* identifiers
** Type: object
** Required : true
* createRelationshipIfNothave
** Type : array
** Required: optional
** Description : using createRelationshipIfNothave for check relationship if not has created , can check both firstNode and SeconNode or onCreateAddRelationships
* onCreateAddRelationships
** Type: array of object
** Required: optional
* relType
** Type: object
** Required: true
* relationshipDirection
** Type: string
** Required: true
* relationshipProperties
** Type: object
** Required: true
* Settings
** Type: object
** Required: true
* settings.updateRelPropsWhenExist
** Type: boolean
** Required: optional
* parentFlowId
** type : string
** Required: true
* callingFlow
** Type: string
** Required: optional
* callingFlowConfig
** Type: object
** Required: optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject": {
"objType": {
"serviceTag": string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"additionalRelationships": [
{
"objType": {
"serviceTag":string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"relType": {
"serviceTag":string,
"relationshipTag":string
},
"relationshipProperties": {
//…properties
},
"relationshipDirection":string // “from” , “to”
}
]
},
"secondObject": {
"objType": {
"serviceTag":string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"additionalRelationships": [
//…optional
]
},
"relType": {
"serviceTag":string,
"relationshipTag":string
},
"relationshipDirection":string, // “from” , “to”
"relationshipProperties": {
//…properties
},
"deepPathConditional": [
{
condition: 'notExist',
conditionCheck: {
nodeStructure: {
objType: {

},
fields: { }
},
nextPath: {
relationshipStructure: {
relType: {

},
relationshipDirection: ''
},
nodeStructure: {
objType: {

},
fields: { }
}
}
}
}
]
"settings": {
"reateOnConditionalFail": false // true default = false
"updateRelPropsWhenExist": boolean,
},
"parentFlowId": "", // required
"callingFlow": "xxxx",
"callingFlowProperties": {
"graphServiceName": string
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.relationship
** Type: object
* queryResult.relationship.relType
** Type: object
* queryResult.relationship.relationshipProperties
** Type: object
* queryResult.firstNode
** Type: object
** Description: return data structure from firstNode
* queryResult.secondNode
** Type: object
** Description: return data structure from secondNode
* queryResult..onCreateAddRelationships
** Type: array
** Description: return data structure from onCreateAddRelationships
* returnValue.firstObject
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* Status
** Type: string
** Description: status from create node // error or complete
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
relationship: {
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//…properties
}
},
firstNode: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: { //… identifiers },
fields: {
//… all fields
}
},
onCreateAddRelationships: [
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//… identifiers
},
fields: {
//… all fields
}
},
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//… all properties
}
}
]
},
secondNode: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: { //… identifiers },
fields: {
//… all fields
}
},
onCreateAddRelationships: [
//… optional
]
}
}
}
}
requestParams: {
// return example send param

},
parentFlowId: "",
Status: 'string', //“complete” // “error”
errorsFound: []
}
}
</syntaxhighlight>

== GetRelationship ==
=== Request Parameters ===
* firstObject
** Type: object
** Required: optional
* secondObject
** Type: object
** Required: optional
* objType
** Type: object
** Required: true
** Description: has serviceTag and objectType
* identifiers
** Type: object
** Required: true
* relType
** Type: object
** Required: true
** Description: has relationshipTag and serviceTag
* relId
** Type: string
** Required: true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag":string,
"objectType":string
},
"identifiers":{
//…identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"relType":{ // required
"relationshipTag": string,
"serviceTag": string
},
"relId": 'string' // // required
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
* Type: object
* queryResult.relType
** Type: object
* queryResult.relationshipProperties
** Type: object
** Description: return relId and properties
* returnValue.toObject
** Type: object
** Description: return toObject if not send secondObject from param
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* errorsFound
** Type: array
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: {
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//…properties : 'string’
}
},
toObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: {
identifiers: {
//
},
fields: { }
}
},
requestParams: {
// return example send param
}
}
}

</syntaxhighlight>

== UpdateRelationship ==
=== Request Parameters ===
* firstObject
** Type: object
** Required: optional
* secondObject
** Type: object
** Required: Optional
* objType
** Type: object
** Required: true
** Description: has serviceTag and objectType
* identifiers
** Type: object
** Required: true
* relId
** Type: string
** Required: true
* relType
** Type: object
** Required: true
** Description: has relationshipTag and serviceTag
* relationshipProperties
** Type: object
** Required: true
** Description: send properties that want to update
* relationshipDirection
** Type: string
** Required: optional
* callingFlow
** Type: string
** Required: optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"relId": string,
"relType":{
"serviceTag":string,
"relationshipTag":string
},
"relationshipProperties":{
//… properties that want to update
},
"relationshipDirection": string, // "from" // “to”
"callingFlow": string
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.firstObject And secondObject
** Type: object
** Description : return objType {seviceTag and objectType} And identifiers
* queryResult.relId
** Type: string
* queryResult.relType
** Type: object
** Description: return {seviceTag and relationshipTag}
* queryResult.relationshipDirection
** Type: string
* queryResult.updatePropertiesParam
** Type: object
** Description: return properties to updated
* queryResult.oldRelationshipProperties
** Type: object
** Description: return old properties before update
* queryResult.newRelationshipProperties
** Type: object
** Description: return new properties after updated
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type : string
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
firstObject: {
objType: {
serviceTag: "string",
objectType: "string"
},
identifiers: {
//…identifiers
}
},
secondObject: {
objType: {
serviceTag: "string",
objectType: "string"
},
identifiers: {
//…identifiers
}
},
relId: "string",
relType: {
serviceTag: "string",
relationshipTag: "string"
},
relationshipDirection: "string",
updatePropertiesParam: {
//… properties updated
},
oldRelationshipProperties: {
// … old properties before update
},
newRelationshipProperties: {
//… new properties after updated
}
}
},
requestParams: {
// return example send param
}
status: “string”, // "complete",”error”
errorsFound: []
}
</syntaxhighlight>

== GetNodeAndRelationship ==
=== Request Parameters ===
* sourceObjType
** Required: true
** Description: has serviceTag and objectType
* sourceIdentifiers
** Type: object
** Required: true
* sourceVersionedDataLabels
** Type: object
** Required: optional
* targetRelationships
** Type: Array
** Required: true
* relTypeAndDirection
** Type: object
** Required: true
* relTypeAndDirection.relType
** Type: object
** Required: true
** Description: has serviceTag and relationshipTag
* relTypeAndDirection.relationshipProperties
** Type: object
** Required: optional
* relTypeAndDirection.relationshipDirection
** Type: String
** Required: optional
* targetObjects
** Type: Array
** Required: Optional
* targetObjects.objType
** Type: object
** Required: required if send targetObjects in param
* targetObjects.identifiers
** Type: object
** Required: optional should have objType if identifiers exists
* targetObjects.versionedDataLabels
** Type: object
** Required: optional have objType if versionedDataLabels exists

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"sourceObjType": { // required
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"sourceIdentifiers": {}, // required
"sourceVersionedDataLabels": [], // optional
"targetRelationships": [ //required
{
"relTypeAndDirection": { // required
"relType": {
"serviceTag": "xxxx",
"relationshipTag": "rel"
},
"relationshipProperties": {},//optional
"relationshipDirection": "" // required
},
"targetObjects": [ // optional
{
"objType": {
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"identifiers": {}, // optional
"versionedDataLabels": [] // optional have objType if versionedDataLabels exists
}
]
},
// if have multiple relTypeAndDirection
],
"settings": {} // defaulf = false >>> if have versionedDataLabels want to return all field of versionedata: settings = { returnSystemFieldsName: true }
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.objTypes
** Type: array of object
** Description: return {serviceTag and objectType}
* queryResult.objInstanceFull
** Type: object
** Description: return {identifiers and fields}
* queryResult.relNodes:
** Type: array
* relNodes.relType
** Type: object
** Description: return {serviceTag and relationshipTag}
* relNodes.relationshipProperties
** Type: object
* relNodes.objTypes
** Type: array of object
** Description: return {serviceTag and objectType}
* relNodes.objInstanceFull
** Type: object
** Description: return {identifiers and fields}
* requestParams
** Type: object
** Description: return same requestParams
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: {},
fields: { }
},
relNodes: [
{
relType: {
serviceTag: 'xxxx',
relationshipTag: 'rel'
},
relationshipProperties: { },
objTypes: [
{
serviceTag: 'xxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: {},
fields: {
// field
}
},
versionDataSystemFields: {
'0VersionDataLabel': {
originTimestamp:
forMatchedId:
versionedDataId:
}
}
}
]
}
},
requestParam : {
// return example send param
},
errorsFound: [],
graphServiceTag: "GraphHandler"
}

</syntaxhighlight>

== ChangeRelationshipType ==
=== Request Parameters ===
* firstObject
** Type : object
** Required : true
* secondObject
** Type : object
** Required : true
* objType
** Type : object
** Required : true
* Identifiers
** Type : object
** Required : true
* oldRelTypeAndDirection
** Type : object
** Required : true
* oldRelTypeAndDirection.relType
** Type : object
** Required : true
* oldRelTypeAndDirection.relationshipDirection
** Type : string
** Required : true
* oldRelTypeAndDirection.relationshipProperties
** Type : object
** Required : optional
* newRelType
** Type : object
** Required : true
* originTimestamp
** Type : number
** Required : true
* changedByUserId
** Type : String
** Required : true
* callingFlow
** Type : String
** Required : optional
* settings
** Type : object
** Required : optional
** Description : default > settings.changeMultipleRelationships : false // if send settings.changeMultipleRelationships : true >> can change multiple relType

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"secondObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"oldRelTypeAndDirection":{
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"old"
},
"relationshipDirection":"from",
"relationshipProperties":{
//Properties
}
},
"newRelType":{
"serviceTag":"xxxx",
"relationshipTag":"new"
},
"originTimestamp":1234567890,
"changedByUserId":"xxxx",
"callingFlow":"yyyy",
"settings":{
"changeMultipleRelationships": boolean: // default false
}
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.newRelationshipType
** Type: object
* newRelationshipType.relType
** Type: object
* newRelationshipType.relationshipDirection
** Type: string
* newRelationshipType.relationshipProperties
** Type: object
* queryResult.oldRelationshipType
** Type: object
* oldRelationshipType.relType
** Type: object
* oldRelationshipType.relationshipDirection
** Type: string
* oldRelationshipType.relationshipProperties
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
newRelationshipType: {
relType: {
serviceTag: "xxxx",
relationshipTag: "new"
},
relationshipDirection: "" // 'from' or 'to'
relationshipProperties: {}
},
oldRelationshipType: {
relType: {
serviceTag: "xxxx",
relationshipTag: "old"
},
relationshipDirection: "" // 'from' or 'to'
relationshipProperties: {}
}
},
requestParams : {
// return example send param
}
},
status: "complete" // or error,
errorsFound: [],
graphServiceTag : 'GraphHandeler'
}

</syntaxhighlight>

== DeleteRelationship ==
=== Request Parameters ===
* fromObject
** Type : object
** Required : optional
* secondObject
** Type : object
** Required : optional
* objType
** Type : object
** Required : true
* Identifiers
** Type : object
** Required : true
* relType
** Type : object
** Required : true
* relId
** Type: string
** Required : true
* relationshipDirection
** Type: string
** Required : optional
* callingFlow
** Type: string
** Required : true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"yyyy"
},
"relId":"string"
},
"relationshipDirection":"string"// "from" or "to"
"callingFlow":"string"
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.objects
** Type: array
* queryResult.objTypes
** Type: array
* queryResult.objInstanceFull.identifiers
** Type: object
* queryResult.objInstanceFull.fields
** Type: object
** Description: return data of fromObject and secondObject
* queryResult.userNode
** Type: object
** Description: return data of userNode
* queryResult.resultDeleteRel
** Type : string
** Description: return status Relationship Delete
* requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objects: [
{
objTypes: [
{
serviceTag: "xxxx",
objectType: "yyyy"
}
],
objInstanceFull: {
identifiers: {
// identifiers
},
fields: {
// fields
}
}
},
{
// if have multiple object objTypes
}
],
userNode: {
objTypes: [
{
serviceTag: "UserAccount",
objectType: "user"
}
],
objInstanceFull: {
identifiers: {
userId: "zzz"
}
}
},
resultDeleteRel: "Relationship Deleted" // default
},
requeatParam: {
// return example send param
},
status: "string", //default "complete" or "error"
errorsFound: []
}
}

</syntaxhighlight>

== DeleteNode ==
=== Request Parameters ===
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* identifiers
** Type : object
** Required: true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":"xxx",
"objectType":"yyy"
},
"identifiers":{
//
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResults
** Type: object
* queryResults.resultDeleteNode
** Type: Boolean
** Description: return status deleted node >> true or false
* requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
** Description: return status deleted node >> complete or error
* errorsFound
** Type: array
* graphServiceTag
** Type: string
=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: { resultDeleteNode: true }, // true or false
requestParams: {
// return example send param
}
},
status: 'string', // 'complete' or 'error'
errorsFound: [],
graphServiceTag: 'GraphHandler'
}
</syntaxhighlight>

== MoveRelationship ==

=== Request Parameters ===
* sourceObject
** Type : object
** Required : true
** Description: required objType: {serviceTag , objectType} and identifiers
* targetObjType
** Type : object
** Required : true
** Description: required objType: {serviceTag , objectType}
* relType
** Type : object
** Required : true
** Description: required objType: {serviceTag , relationshipTag}
* relationshipDirection
** Type : object
** Required : true
* moveToIdentifiers
** Type : object
** Required : true
* moveByUserId
** Type : String
** Required : true
* originTimestamp
** Type : number
** Required : true
* settings
** Type : object
** Required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"sourceObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyy"
},
"identifiers":{
// identifiers
}
},
"targetObjType":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
}
},
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"rel"
},
"relationshipDirection":"from", // "to"
"moveToIdentifiers":{
// target identifiers
},
"moveByUserId":"xxxx",
"originTimestamp":1234567890,
"settings":{}
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.moveRelationship
** Type: object
* moveRelationship.sourceObject
** Type: object
** Description: return data of sourceObject
* moveRelationship.relationship
** Type: string
** Description: return data of after move relationship
* moveRelationship.moveToObject
** Type: object
** Description: return data of moveToObject
* moveRelationship.historyData
** Type: object
** Description: return properties {old target identifiers and originTimestamp} after moveRelationship
* moveRelationship.userNode
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
moveRelationship: {
sourceObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
}
},
relationship: {
relType: {
serviceTag: 'xxxx',
relationshipTag: 'rel'
},
relationshipProperties: { originTimestamp: 1234567890 }
},
moveToObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: { }
},
historyData: {
relationshipProperties: { }
},
userNode: {
objTypes: [{ serviceTag: 'UserAccount', objectType: 'user' }],
objInstanceFull: { }
}
}
},
requestParam: {
}
}
status: "complete" // or error,
errorsFound: [],
graphServiceTag: 'GraphHandler'
}

</syntaxhighlight>

== MoveNodeProperties ==
=== Request Parameters ===
* sourceObject
** type: object
** required : true
* targetIdentifiers
** type : object
** required : true
* moveProperties
** type : array
** required : true // index minimum = 1
* updateProperties
** type : object
** required : true
* movePropertiesConditions
** type : array
** required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
sourceObject: {
objType: { },
identifier: { }
},
targetIdentifiers: { },
moveProperties: [ ],
updateProperties: { },
movePropertiesConditions: [ // optional
{
checkObject: 'target', // "source" | "target"
onSetObject: 'target', // "source" | "target"
onPassValue: true,
onNotPassCondition: false, // optional
fieldNameConditions: [ ]
}
]
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.moveNodeProperties
** Type: object
* moveNodeProperties.sourceObject
** Type: object
** Description: return data of sourceObject
* moveRelationship.moveFieldToObject
** Type: string
** Description: return data after moveFieldToObject
* moveRelationship.movedFields
** Type: object
** Description: return data field of moveToObject
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String
=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
moveNodeProperties: {
sourceObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: {
identifiers: { },
fields: { }
}
},
moveFieldToObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: { },
fields: {

}
},
movedFields: { Fields: { } } //
}
}
},
requestParam: { },
status: 'complete',
errorsFound: [],
graphServiceTag: 'GraphHandler'
}
</syntaxhighlight>
[[Category:Working documents| 2025-03-06]]

2025-03-06 - Graph Handler Docs

2026-06-03T05:57:54Z

Seagame: /* Return Example */

= GraphHandler Function =
== CreateNode ==
'''Use Case of CreateNode''' >>> https://izara.io/wiki/index.php/2025-03-27_Graph_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
* setFieldConditionals
** type : array
** Required : optional
* deepPathConditional
** type : array
** Required : optional
* parentFlowId
** type : string
** Required: true
* callingFlowConfig
** Type: object
** Required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType": {
"objectType": string,
"serviceTag": string
},
"objInstanceFull": {
"identifiers": {
// ...identifier
},
"fields": {
// ...fields
}
},
setFieldConditionals: [ // optional default array
{
objType: { },
indexValue: { nameSpace: 'ex-011', systemTextTag: 'Gate-011' }, // index field : value
fieldName: '', // fieldName want to set
passValue: 'false', optional
notPassValue: 'true', //optional
conditionals: [ optional ] // condition check field
}
],
"relationships": [
{
"relType": {
"serviceTag": string,
"relationshipTag": string
},
"relationshipProperties": {
//... key and value of targetIdentifiers
},
"relationshipDirection": string, // "from" | "to"
"targetObjType": {
"serviceTag": string,
"objectType": string
},
"targetIdentifiers": {
//... targetIdentifiers
}
}
],
deepPathConditional: [ // optional default array
{
condition: 'notExist', //
conditionCheck: { // traversal
nodeStructure: {
objType: { },
fields: { }
},
nextPath: {
relationshipStructure: {
relType: { },
relationshipDirection: 'to'
},
nodeStructure: {
objType: { },
fields: { }
}
}
}
}
],
"originTimestamp": number, // timestamp when create
"settings": {
"updatePropertiesOnMatch": boolean // default=false
},
"parentFlowId": "", // required
"callingFlow": string,
"callingFlowProperties": object,
}
</syntaxhighlight>

=== 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.relationships
** Type: array
** Description: data from relationships in targetNode
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* Status
** Type: string
** Description: Status from create node. Return "error" or "complete".
* errorsFound
** Type: array
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">

{
returnValue: {
queryResult: {
returnCreateNode: {
objTypes: [
{
serviceTag: "string",
objectType: "string"
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//...fields
}
},
existsNode: { },
userNode: { // // if has userNode send to createNode
objTypes: [
{
"serviceTag": "UserAccount",
"objectType": "user"
}
],
properties: {
//...properties
}
},
relationships: [ // optional : if has requiredOnCreated , createNode with targetNode
{
objTypes: [
{ serviceTag: 'string', objectType: 'string' }
],
objInstanceFull: {
identifiers: {
// identifiers
}
},
relType: {
serviceTag: 'string',
relationshipTag: 'rel'
},
relationshipProperties: {
// properties
}
},
]
}
},
requestParams: {
// return example send param
},
parentFlowId:""
},
status: "string", // "complete' or "error"
errorsFound: [],
graphServiceTag: "GraphHandler"
}

</syntaxhighlight>

== GetNode ==
'''Use Case of GetNode''' >>> https://izara.io/wiki/index.php/2025-04-23_Graph_Use_Case/GetNode_and_GetNodes#Use_Case_GetNodes
=== 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
* versionedDataLabels
** Type: Array
** Required : optional
* settings.updatePropertiesOnMatch
** Type: Boolean
** Required : optional
* parentFlowId
** Type: string
** Required: optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":string,
"objectType":string
},
"objInstanceFull":{
"identifiers":{
// ...identifier
},
"fields":{
// ...fields
}
},
"versionedDataLabels":[
//…versionedData
],
"settings": {
"returnSystemFieldsName" :boolean // default = true or false
},
"parentFlowId" : "" // optional
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* returnValue.queryResult
** Type: object
* queryResult.refactoredNodes
** Type: object
** Description: return object from getNode
* refactoredNodes.objTypes
** Type: array
* refactoredNodes.objInstanceFull
** Type: object
* refactoredNodes.objInstanceFull.identifiers
** Type: object
* refactoredNodes.objInstanceFull.fields
** Type: object
* refactoredNodes.versionDataSystemFields
** Type: object
* refactoredNodes.versionDataSystemFields.versionedDataLabel
** Type: object
* queryResult.requestParam
** Type: object
** Description: return example send param
* errorsFound
** Type: string
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
refactoredNodes: {
objTypes: [
{
serviceTag: "string",
objectType: "string",
}
],
objInstanceFull: {
identifiers: {
//… identifier
},
fields: {
//…fields
}
},
versionDataSystemFields: {
versionedDataLabel: {
originTimestamp: number,
forMatchedId: "string",
versionedDataId: "string"
}
}
}
},
requestParam: {
// return example send param
}
},
errorsFound: [],
graphServiceTag: ''
}
</syntaxhighlight>

== GetNodes ==
'''Use Case of GetNodes''' >>> https://izara.io/wiki/index.php/2025-04-23_Graph_Use_Case/GetNode_and_GetNodes#Use_Case_GetNodes
=== Request Parameters ===
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* fields
** Type : object
** Required: true
* versionedDataLabels
** Type: Array
** Required : optional
* settings.returnSystemFieldsName
** Type: Boolean
** Required : optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":string,
"objectType":string
},
"fields":{
//…fields with matching value
},
"versionedDataLabels":[
//…versionedDataLabels
],
"settings":{
"returnSystemFieldsName":boolean // default=false
},
"parentFlowId" :"" // optional
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResults
** Type: object
* queryResults.getNodesReturnValues
** Type: array
* getNodesReturnValues.objTypes
** Type: array
* getNodesReturnValues.objInstanceFull
** Type: object
* getNodesReturnValues.objInstanceFull.identifiers
** Type: object
* getNodesReturnValues.objInstanceFull.fields
** Type: object
* getNodesReturnValues.versionDataSystemFields
** Type: object
* getNodesReturnValues.versionDataSystemFields.versionedDataLabel
** Type: object
* requestParams
** Type: object
* errorsFound
** Type: string
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: {
getNodesReturnValues: [
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//.. all fields-1
}
},
versionDataSystemFields: {}
},
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//...all fields-2
}
},
versionDataSystemFields: {
versionedDataLabel: {
originTimestamp: number,
forMatchedId: 'string',
versionedDataId: 'string'
}
}
}
]
},
requestParams: {
// return example send param
}
}
}
</syntaxhighlight>

== UpdateNode ==
''' Use Case of UpdateNode''' >>> https://izara.io/wiki/index.php/2025-08-03_-_Graph_Use_Case/UpdateNode
=== 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: object
** Required : true
* objInstanceFull.fields
** Type : object
** Required: true
** Description : can not send fields to update mainNode and versionedData together
* versionedDataIds
** Type: object
** Required: optional
* originTimestamp
** Type: number
** Required: true
* settings
** Type: object
** Required: optional
* parentFlowId
** type : string
** Required: true
* callingFlow
** Type: string
** Required: optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType": {
"serviceTag": string,
"objectType": string
},
"objInstanceFull": {
"identifiers": {
//…identifiers
},
"fields": {
//…fields
// can not be send fields of mainNode and versionedData in fields together!
}
},
"versionedDataIds": {},
"originTimestamp": number, //// timestamp when update
"settings": {},
"parentFlowId": ""// required
"callingFlow": string
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* returnValue.queryResult
** Type: object
** Description: data from created node
* queryResult.objTypes
** Type: array
** Description: serviceTag and objectType
* queryResult.objInstanceFull
** Type: object
** Description: identifiers and fields
* queryResult.userId
** Type: object
** Description: data that update from user Account
* queryResult.versionDataSystemFields
** Type: object
** Description: optional return versionedData
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* returnValue.Status
** Type: string
** Description: status from updated node // error or complete
* returnValue.errorsFound
** Type: array
* returnValue.graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifiers
},
fields: {
//...fields
}
},
userId: {
// if have userNode send to updated
},
versionDataSystemFields: {
versionedDataLabel: {
}
}
},
requestParams: {
// return example send param
},
parentFlowId:""
},
status: 'string',//"complete" // "error"
errorsFound: [],
graphServiceTag: 'string'
}
</syntaxhighlight>

== CreateRelationship ==
''' Use Case of CreateRelationship''' >>> https://izara.io/wiki/index.php/2025-08-01_-_Graph_Use_Case/CreateRelationship
=== Request Parameters ===
* firstObject
** Type: object
** Required: true
* secondObject
** Type: object
** Required: true
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* identifiers
** Type: object
** Required : true
* createRelationshipIfNothave
** Type : array
** Required: optional
** Description : using createRelationshipIfNothave for check relationship if not has created , can check both firstNode and SeconNode or onCreateAddRelationships
* onCreateAddRelationships
** Type: array of object
** Required: optional
* relType
** Type: object
** Required: true
* relationshipDirection
** Type: string
** Required: true
* relationshipProperties
** Type: object
** Required: true
* Settings
** Type: object
** Required: true
* settings.updateRelPropsWhenExist
** Type: boolean
** Required: optional
* callingFlow
** Type: string
** Required: optional
* callingFlowConfig
** Type: object
** Required: optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject": {
"objType": {
"serviceTag": string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"createRelationshipIfNothave": [ // optional
{
"onMatchRelationship": {
"relType": {
"serviceTag": string,
"relationshipTag": string
},
"relationshipProperties": {},
"relationshipDirection": string
},
"onMatchNode": {
"objType": {
"serviceTag":string,
"objectType": string
},
"fields": {
}
}
}
],
"onCreateAddRelationships": [
{
"objType": {
"serviceTag":string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"relType": {
"serviceTag":string,
"relationshipTag":string
},
"relationshipProperties": {
//…properties
},
"relationshipDirection":string // “from” , “to”
}
]
},
"secondObject": {
"objType": {
"serviceTag":string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"onCreateAddRelationships": [
//…optional
]
},
"relType": {
"serviceTag":string,
"relationshipTag":string
},
"relationshipDirection":string, // “from” , “to”
"relationshipProperties": {
//…properties
},
"settings": {
"updateRelPropsWhenExist": boolean,
},
"callingFlow": "xxxx",
"callingFlowProperties": {
"graphServiceName": string
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.relationship
** Type: object
* queryResult.relationship.relType
** Type: object
* queryResult.relationship.relationshipProperties
** Type: object
* queryResult.firstNode
** Type: object
** Description: return data structure from firstNode
* queryResult.secondNode
** Type: object
** Description: return data structure from secondNode
* queryResult..onCreateAddRelationships
** Type: array
** Description: return data structure from onCreateAddRelationships
* returnValue.firstObject
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* Status
** Type: string
** Description: status from create node // error or complete
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
relationship: {
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//…properties
}
},
firstNode: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: { //… identifiers },
fields: {
//… all fields
}
},
onCreateAddRelationships: [
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//… identifiers
},
fields: {
//… all fields
}
},
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//… all properties
}
}
]
},
secondNode: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: { //… identifiers },
fields: {
//… all fields
}
},
onCreateAddRelationships: [
//… optional
]
}
}
}
}
requestParams: {
// return example send param

},
Status: 'string', //“complete” // “error”
errorsFound: []
}
}
</syntaxhighlight>

== GetRelationship ==
=== Request Parameters ===
* firstObject
** Type: object
** Required: optional
* secondObject
** Type: object
** Required: optional
* objType
** Type: object
** Required: true
** Description: has serviceTag and objectType
* identifiers
** Type: object
** Required: true
* relType
** Type: object
** Required: true
** Description: has relationshipTag and serviceTag
* relId
** Type: string
** Required: true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag":string,
"objectType":string
},
"identifiers":{
//…identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"relType":{ // required
"relationshipTag": string,
"serviceTag": string
},
"relId": 'string' // // required
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
* Type: object
* queryResult.relType
** Type: object
* queryResult.relationshipProperties
** Type: object
** Description: return relId and properties
* returnValue.toObject
** Type: object
** Description: return toObject if not send secondObject from param
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* errorsFound
** Type: array
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: {
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//…properties : 'string’
}
},
toObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: {
identifiers: {
//
},
fields: { }
}
},
requestParams: {
// return example send param
}
}
}

</syntaxhighlight>

== UpdateRelationship ==
=== Request Parameters ===
* firstObject
** Type: object
** Required: optional
* secondObject
** Type: object
** Required: Optional
* objType
** Type: object
** Required: true
** Description: has serviceTag and objectType
* identifiers
** Type: object
** Required: true
* relId
** Type: string
** Required: true
* relType
** Type: object
** Required: true
** Description: has relationshipTag and serviceTag
* relationshipProperties
** Type: object
** Required: true
** Description: send properties that want to update
* relationshipDirection
** Type: string
** Required: optional
* callingFlow
** Type: string
** Required: optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"relId": string,
"relType":{
"serviceTag":string,
"relationshipTag":string
},
"relationshipProperties":{
//… properties that want to update
},
"relationshipDirection": string, // "from" // “to”
"callingFlow": string
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.firstObject And secondObject
** Type: object
** Description : return objType {seviceTag and objectType} And identifiers
* queryResult.relId
** Type: string
* queryResult.relType
** Type: object
** Description: return {seviceTag and relationshipTag}
* queryResult.relationshipDirection
** Type: string
* queryResult.updatePropertiesParam
** Type: object
** Description: return properties to updated
* queryResult.oldRelationshipProperties
** Type: object
** Description: return old properties before update
* queryResult.newRelationshipProperties
** Type: object
** Description: return new properties after updated
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type : string
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
firstObject: {
objType: {
serviceTag: "string",
objectType: "string"
},
identifiers: {
//…identifiers
}
},
secondObject: {
objType: {
serviceTag: "string",
objectType: "string"
},
identifiers: {
//…identifiers
}
},
relId: "string",
relType: {
serviceTag: "string",
relationshipTag: "string"
},
relationshipDirection: "string",
updatePropertiesParam: {
//… properties updated
},
oldRelationshipProperties: {
// … old properties before update
},
newRelationshipProperties: {
//… new properties after updated
}
}
},
requestParams: {
// return example send param
}
status: “string”, // "complete",”error”
errorsFound: []
}
</syntaxhighlight>

== GetNodeAndRelationship ==
=== Request Parameters ===
* sourceObjType
** Required: true
** Description: has serviceTag and objectType
* sourceIdentifiers
** Type: object
** Required: true
* sourceVersionedDataLabels
** Type: object
** Required: optional
* targetRelationships
** Type: Array
** Required: true
* relTypeAndDirection
** Type: object
** Required: true
* relTypeAndDirection.relType
** Type: object
** Required: true
** Description: has serviceTag and relationshipTag
* relTypeAndDirection.relationshipProperties
** Type: object
** Required: optional
* relTypeAndDirection.relationshipDirection
** Type: String
** Required: optional
* targetObjects
** Type: Array
** Required: Optional
* targetObjects.objType
** Type: object
** Required: required if send targetObjects in param
* targetObjects.identifiers
** Type: object
** Required: optional should have objType if identifiers exists
* targetObjects.versionedDataLabels
** Type: object
** Required: optional have objType if versionedDataLabels exists

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"sourceObjType": { // required
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"sourceIdentifiers": {}, // required
"sourceVersionedDataLabels": [], // optional
"targetRelationships": [ //required
{
"relTypeAndDirection": { // required
"relType": {
"serviceTag": "xxxx",
"relationshipTag": "rel"
},
"relationshipProperties": {},//optional
"relationshipDirection": "" // required
},
"targetObjects": [ // optional
{
"objType": {
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"identifiers": {}, // optional
"versionedDataLabels": [] // optional have objType if versionedDataLabels exists
}
]
},
// if have multiple relTypeAndDirection
],
"settings": {} // defaulf = false >>> if have versionedDataLabels want to return all field of versionedata: settings = { returnSystemFieldsName: true }
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.objTypes
** Type: array of object
** Description: return {serviceTag and objectType}
* queryResult.objInstanceFull
** Type: object
** Description: return {identifiers and fields}
* queryResult.relNodes:
** Type: array
* relNodes.relType
** Type: object
** Description: return {serviceTag and relationshipTag}
* relNodes.relationshipProperties
** Type: object
* relNodes.objTypes
** Type: array of object
** Description: return {serviceTag and objectType}
* relNodes.objInstanceFull
** Type: object
** Description: return {identifiers and fields}
* requestParams
** Type: object
** Description: return same requestParams
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: {},
fields: { }
},
relNodes: [
{
relType: {
serviceTag: 'xxxx',
relationshipTag: 'rel'
},
relationshipProperties: { },
objTypes: [
{
serviceTag: 'xxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: {},
fields: {
// field
}
},
versionDataSystemFields: {
'0VersionDataLabel': {
originTimestamp:
forMatchedId:
versionedDataId:
}
}
}
]
}
},
requestParam : {
// return example send param
},
errorsFound: [],
graphServiceTag: "GraphHandler"
}

</syntaxhighlight>

== ChangeRelationshipType ==
=== Request Parameters ===
* firstObject
** Type : object
** Required : true
* secondObject
** Type : object
** Required : true
* objType
** Type : object
** Required : true
* Identifiers
** Type : object
** Required : true
* oldRelTypeAndDirection
** Type : object
** Required : true
* oldRelTypeAndDirection.relType
** Type : object
** Required : true
* oldRelTypeAndDirection.relationshipDirection
** Type : string
** Required : true
* oldRelTypeAndDirection.relationshipProperties
** Type : object
** Required : optional
* newRelType
** Type : object
** Required : true
* originTimestamp
** Type : number
** Required : true
* changedByUserId
** Type : String
** Required : true
* callingFlow
** Type : String
** Required : optional
* settings
** Type : object
** Required : optional
** Description : default > settings.changeMultipleRelationships : false // if send settings.changeMultipleRelationships : true >> can change multiple relType

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"secondObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"oldRelTypeAndDirection":{
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"old"
},
"relationshipDirection":"from",
"relationshipProperties":{
//Properties
}
},
"newRelType":{
"serviceTag":"xxxx",
"relationshipTag":"new"
},
"originTimestamp":1234567890,
"changedByUserId":"xxxx",
"callingFlow":"yyyy",
"settings":{
"changeMultipleRelationships": boolean: // default false
}
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.newRelationshipType
** Type: object
* newRelationshipType.relType
** Type: object
* newRelationshipType.relationshipDirection
** Type: string
* newRelationshipType.relationshipProperties
** Type: object
* queryResult.oldRelationshipType
** Type: object
* oldRelationshipType.relType
** Type: object
* oldRelationshipType.relationshipDirection
** Type: string
* oldRelationshipType.relationshipProperties
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
newRelationshipType: {
relType: {
serviceTag: "xxxx",
relationshipTag: "new"
},
relationshipDirection: "" // 'from' or 'to'
relationshipProperties: {}
},
oldRelationshipType: {
relType: {
serviceTag: "xxxx",
relationshipTag: "old"
},
relationshipDirection: "" // 'from' or 'to'
relationshipProperties: {}
}
},
requestParams : {
// return example send param
}
},
status: "complete" // or error,
errorsFound: [],
graphServiceTag : 'GraphHandeler'
}

</syntaxhighlight>

== DeleteRelationship ==
=== Request Parameters ===
* fromObject
** Type : object
** Required : optional
* secondObject
** Type : object
** Required : optional
* objType
** Type : object
** Required : true
* Identifiers
** Type : object
** Required : true
* relType
** Type : object
** Required : true
* relId
** Type: string
** Required : true
* relationshipDirection
** Type: string
** Required : optional
* callingFlow
** Type: string
** Required : true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"yyyy"
},
"relId":"string"
},
"relationshipDirection":"string"// "from" or "to"
"callingFlow":"string"
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.objects
** Type: array
* queryResult.objTypes
** Type: array
* queryResult.objInstanceFull.identifiers
** Type: object
* queryResult.objInstanceFull.fields
** Type: object
** Description: return data of fromObject and secondObject
* queryResult.userNode
** Type: object
** Description: return data of userNode
* queryResult.resultDeleteRel
** Type : string
** Description: return status Relationship Delete
* requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objects: [
{
objTypes: [
{
serviceTag: "xxxx",
objectType: "yyyy"
}
],
objInstanceFull: {
identifiers: {
// identifiers
},
fields: {
// fields
}
}
},
{
// if have multiple object objTypes
}
],
userNode: {
objTypes: [
{
serviceTag: "UserAccount",
objectType: "user"
}
],
objInstanceFull: {
identifiers: {
userId: "zzz"
}
}
},
resultDeleteRel: "Relationship Deleted" // default
},
requeatParam: {
// return example send param
},
status: "string", //default "complete" or "error"
errorsFound: []
}
}

</syntaxhighlight>

== DeleteNode ==
=== Request Parameters ===
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* identifiers
** Type : object
** Required: true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":"xxx",
"objectType":"yyy"
},
"identifiers":{
//
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResults
** Type: object
* queryResults.resultDeleteNode
** Type: Boolean
** Description: return status deleted node >> true or false
* requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
** Description: return status deleted node >> complete or error
* errorsFound
** Type: array
* graphServiceTag
** Type: string
=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: { resultDeleteNode: true }, // true or false
requestParams: {
// return example send param
}
},
status: 'string', // 'complete' or 'error'
errorsFound: [],
graphServiceTag: 'GraphHandler'
}
</syntaxhighlight>

== MoveRelationship ==

=== Request Parameters ===
* sourceObject
** Type : object
** Required : true
** Description: required objType: {serviceTag , objectType} and identifiers
* targetObjType
** Type : object
** Required : true
** Description: required objType: {serviceTag , objectType}
* relType
** Type : object
** Required : true
** Description: required objType: {serviceTag , relationshipTag}
* relationshipDirection
** Type : object
** Required : true
* moveToIdentifiers
** Type : object
** Required : true
* moveByUserId
** Type : String
** Required : true
* originTimestamp
** Type : number
** Required : true
* settings
** Type : object
** Required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"sourceObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyy"
},
"identifiers":{
// identifiers
}
},
"targetObjType":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
}
},
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"rel"
},
"relationshipDirection":"from", // "to"
"moveToIdentifiers":{
// target identifiers
},
"moveByUserId":"xxxx",
"originTimestamp":1234567890,
"settings":{}
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.moveRelationship
** Type: object
* moveRelationship.sourceObject
** Type: object
** Description: return data of sourceObject
* moveRelationship.relationship
** Type: string
** Description: return data of after move relationship
* moveRelationship.moveToObject
** Type: object
** Description: return data of moveToObject
* moveRelationship.historyData
** Type: object
** Description: return properties {old target identifiers and originTimestamp} after moveRelationship
* moveRelationship.userNode
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
moveRelationship: {
sourceObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
}
},
relationship: {
relType: {
serviceTag: 'xxxx',
relationshipTag: 'rel'
},
relationshipProperties: { originTimestamp: 1234567890 }
},
moveToObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: { }
},
historyData: {
relationshipProperties: { }
},
userNode: {
objTypes: [{ serviceTag: 'UserAccount', objectType: 'user' }],
objInstanceFull: { }
}
}
},
requestParam: {
}
}
status: "complete" // or error,
errorsFound: [],
graphServiceTag: 'GraphHandler'
}

</syntaxhighlight>

== MoveNodeProperties ==
=== Request Parameters ===
* sourceObject
** type: object
** required : true
* targetIdentifiers
** type : object
** required : true
* moveProperties
** type : array
** required : true // index minimum = 1
* updateProperties
** type : object
** required : true
* movePropertiesConditions
** type : array
** required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
sourceObject: {
objType: { },
identifier: { }
},
targetIdentifiers: { },
moveProperties: [ ],
updateProperties: { },
movePropertiesConditions: [ // optional
{
checkObject: 'target', // "source" | "target"
onSetObject: 'target', // "source" | "target"
onPassValue: true,
onNotPassCondition: false, // optional
fieldNameConditions: [ ]
}
]
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.moveNodeProperties
** Type: object
* moveNodeProperties.sourceObject
** Type: object
** Description: return data of sourceObject
* moveRelationship.moveFieldToObject
** Type: string
** Description: return data after moveFieldToObject
* moveRelationship.movedFields
** Type: object
** Description: return data field of moveToObject
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String
=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
moveNodeProperties: {
sourceObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: {
identifiers: { },
fields: { }
}
},
moveFieldToObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: { },
fields: {

}
},
movedFields: { Fields: { } } //
}
}
},
requestParam: { },
status: 'complete',
errorsFound: [],
graphServiceTag: 'GraphHandler'
}
</syntaxhighlight>
[[Category:Working documents| 2025-03-06]]

2025-03-06 - Graph Handler Docs

2026-06-03T05:57:21Z

Seagame: /* Request Parameters */

= GraphHandler Function =
== CreateNode ==
'''Use Case of CreateNode''' >>> https://izara.io/wiki/index.php/2025-03-27_Graph_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
* setFieldConditionals
** type : array
** Required : optional
* deepPathConditional
** type : array
** Required : optional
* parentFlowId
** type : string
** Required: true
* callingFlowConfig
** Type: object
** Required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType": {
"objectType": string,
"serviceTag": string
},
"objInstanceFull": {
"identifiers": {
// ...identifier
},
"fields": {
// ...fields
}
},
setFieldConditionals: [ // optional default array
{
objType: { },
indexValue: { nameSpace: 'ex-011', systemTextTag: 'Gate-011' }, // index field : value
fieldName: '', // fieldName want to set
passValue: 'false', optional
notPassValue: 'true', //optional
conditionals: [ optional ] // condition check field
}
],
"relationships": [
{
"relType": {
"serviceTag": string,
"relationshipTag": string
},
"relationshipProperties": {
//... key and value of targetIdentifiers
},
"relationshipDirection": string, // "from" | "to"
"targetObjType": {
"serviceTag": string,
"objectType": string
},
"targetIdentifiers": {
//... targetIdentifiers
}
}
],
deepPathConditional: [ // optional default array
{
condition: 'notExist', //
conditionCheck: { // traversal
nodeStructure: {
objType: { },
fields: { }
},
nextPath: {
relationshipStructure: {
relType: { },
relationshipDirection: 'to'
},
nodeStructure: {
objType: { },
fields: { }
}
}
}
}
],
"originTimestamp": number, // timestamp when create
"settings": {
"updatePropertiesOnMatch": boolean // default=false
},
"parentFlowId": "", // required
"callingFlow": string,
"callingFlowProperties": object,
}
</syntaxhighlight>

=== 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.relationships
** Type: array
** Description: data from relationships in targetNode
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* Status
** Type: string
** Description: Status from create node. Return "error" or "complete".
* errorsFound
** Type: array
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">

{
returnValue: {
queryResult: {
returnCreateNode: {
objTypes: [
{
serviceTag: "string",
objectType: "string"
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//...fields
}
},
existsNode: { },
userNode: { // // if has userNode send to createNode
objTypes: [
{
"serviceTag": "UserAccount",
"objectType": "user"
}
],
properties: {
//...properties
}
},
relationships: [ // optional : if has requiredOnCreated , createNode with targetNode
{
objTypes: [
{ serviceTag: 'string', objectType: 'string' }
],
objInstanceFull: {
identifiers: {
// identifiers
}
},
relType: {
serviceTag: 'string',
relationshipTag: 'rel'
},
relationshipProperties: {
// properties
}
},
]
}
},
requestParams: {
// return example send param
},
parentFlowId:""
},
status: "string", // "complete' or "error"
errorsFound: [],
graphServiceTag: "GraphHandler"
}

</syntaxhighlight>

== GetNode ==
'''Use Case of GetNode''' >>> https://izara.io/wiki/index.php/2025-04-23_Graph_Use_Case/GetNode_and_GetNodes#Use_Case_GetNodes
=== 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
* versionedDataLabels
** Type: Array
** Required : optional
* settings.updatePropertiesOnMatch
** Type: Boolean
** Required : optional
* parentFlowId
** Type: string
** Required: optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":string,
"objectType":string
},
"objInstanceFull":{
"identifiers":{
// ...identifier
},
"fields":{
// ...fields
}
},
"versionedDataLabels":[
//…versionedData
],
"settings": {
"returnSystemFieldsName" :boolean // default = true or false
},
"parentFlowId" : "" // optional
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* returnValue.queryResult
** Type: object
* queryResult.refactoredNodes
** Type: object
** Description: return object from getNode
* refactoredNodes.objTypes
** Type: array
* refactoredNodes.objInstanceFull
** Type: object
* refactoredNodes.objInstanceFull.identifiers
** Type: object
* refactoredNodes.objInstanceFull.fields
** Type: object
* refactoredNodes.versionDataSystemFields
** Type: object
* refactoredNodes.versionDataSystemFields.versionedDataLabel
** Type: object
* queryResult.requestParam
** Type: object
** Description: return example send param
* errorsFound
** Type: string
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
refactoredNodes: {
objTypes: [
{
serviceTag: "string",
objectType: "string",
}
],
objInstanceFull: {
identifiers: {
//… identifier
},
fields: {
//…fields
}
},
versionDataSystemFields: {
versionedDataLabel: {
originTimestamp: number,
forMatchedId: "string",
versionedDataId: "string"
}
}
}
},
requestParam: {
// return example send param
}
},
errorsFound: [],
graphServiceTag: ''
}
</syntaxhighlight>

== GetNodes ==
'''Use Case of GetNodes''' >>> https://izara.io/wiki/index.php/2025-04-23_Graph_Use_Case/GetNode_and_GetNodes#Use_Case_GetNodes
=== Request Parameters ===
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* fields
** Type : object
** Required: true
* versionedDataLabels
** Type: Array
** Required : optional
* settings.returnSystemFieldsName
** Type: Boolean
** Required : optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":string,
"objectType":string
},
"fields":{
//…fields with matching value
},
"versionedDataLabels":[
//…versionedDataLabels
],
"settings":{
"returnSystemFieldsName":boolean // default=false
},
"parentFlowId" :"" // optional
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResults
** Type: object
* queryResults.getNodesReturnValues
** Type: array
* getNodesReturnValues.objTypes
** Type: array
* getNodesReturnValues.objInstanceFull
** Type: object
* getNodesReturnValues.objInstanceFull.identifiers
** Type: object
* getNodesReturnValues.objInstanceFull.fields
** Type: object
* getNodesReturnValues.versionDataSystemFields
** Type: object
* getNodesReturnValues.versionDataSystemFields.versionedDataLabel
** Type: object
* requestParams
** Type: object
* errorsFound
** Type: string
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: {
getNodesReturnValues: [
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//.. all fields-1
}
},
versionDataSystemFields: {}
},
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//...all fields-2
}
},
versionDataSystemFields: {
versionedDataLabel: {
originTimestamp: number,
forMatchedId: 'string',
versionedDataId: 'string'
}
}
}
]
},
requestParams: {
// return example send param
}
}
}
</syntaxhighlight>

== UpdateNode ==
''' Use Case of UpdateNode''' >>> https://izara.io/wiki/index.php/2025-08-03_-_Graph_Use_Case/UpdateNode
=== 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: object
** Required : true
* objInstanceFull.fields
** Type : object
** Required: true
** Description : can not send fields to update mainNode and versionedData together
* versionedDataIds
** Type: object
** Required: optional
* originTimestamp
** Type: number
** Required: true
* settings
** Type: object
** Required: optional
* parentFlowId
** type : string
** Required: true
* callingFlow
** Type: string
** Required: optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType": {
"serviceTag": string,
"objectType": string
},
"objInstanceFull": {
"identifiers": {
//…identifiers
},
"fields": {
//…fields
// can not be send fields of mainNode and versionedData in fields together!
}
},
"versionedDataIds": {},
"originTimestamp": number, //// timestamp when update
"settings": {},
"parentFlowId": ""// required
"callingFlow": string
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* returnValue.queryResult
** Type: object
** Description: data from created node
* queryResult.objTypes
** Type: array
** Description: serviceTag and objectType
* queryResult.objInstanceFull
** Type: object
** Description: identifiers and fields
* queryResult.userId
** Type: object
** Description: data that update from user Account
* queryResult.versionDataSystemFields
** Type: object
** Description: optional return versionedData
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* returnValue.Status
** Type: string
** Description: status from updated node // error or complete
* returnValue.errorsFound
** Type: array
* returnValue.graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifiers
},
fields: {
//...fields
}
},
userId: {
// if have userNode send to updated
},
versionDataSystemFields: {
versionedDataLabel: {
}
}
},
requestParams: {
// return example send param
}
},
status: 'string',//"complete" // "error"
errorsFound: [],
graphServiceTag: 'string'
}
</syntaxhighlight>

== CreateRelationship ==
''' Use Case of CreateRelationship''' >>> https://izara.io/wiki/index.php/2025-08-01_-_Graph_Use_Case/CreateRelationship
=== Request Parameters ===
* firstObject
** Type: object
** Required: true
* secondObject
** Type: object
** Required: true
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* identifiers
** Type: object
** Required : true
* createRelationshipIfNothave
** Type : array
** Required: optional
** Description : using createRelationshipIfNothave for check relationship if not has created , can check both firstNode and SeconNode or onCreateAddRelationships
* onCreateAddRelationships
** Type: array of object
** Required: optional
* relType
** Type: object
** Required: true
* relationshipDirection
** Type: string
** Required: true
* relationshipProperties
** Type: object
** Required: true
* Settings
** Type: object
** Required: true
* settings.updateRelPropsWhenExist
** Type: boolean
** Required: optional
* callingFlow
** Type: string
** Required: optional
* callingFlowConfig
** Type: object
** Required: optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject": {
"objType": {
"serviceTag": string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"createRelationshipIfNothave": [ // optional
{
"onMatchRelationship": {
"relType": {
"serviceTag": string,
"relationshipTag": string
},
"relationshipProperties": {},
"relationshipDirection": string
},
"onMatchNode": {
"objType": {
"serviceTag":string,
"objectType": string
},
"fields": {
}
}
}
],
"onCreateAddRelationships": [
{
"objType": {
"serviceTag":string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"relType": {
"serviceTag":string,
"relationshipTag":string
},
"relationshipProperties": {
//…properties
},
"relationshipDirection":string // “from” , “to”
}
]
},
"secondObject": {
"objType": {
"serviceTag":string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"onCreateAddRelationships": [
//…optional
]
},
"relType": {
"serviceTag":string,
"relationshipTag":string
},
"relationshipDirection":string, // “from” , “to”
"relationshipProperties": {
//…properties
},
"settings": {
"updateRelPropsWhenExist": boolean,
},
"callingFlow": "xxxx",
"callingFlowProperties": {
"graphServiceName": string
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.relationship
** Type: object
* queryResult.relationship.relType
** Type: object
* queryResult.relationship.relationshipProperties
** Type: object
* queryResult.firstNode
** Type: object
** Description: return data structure from firstNode
* queryResult.secondNode
** Type: object
** Description: return data structure from secondNode
* queryResult..onCreateAddRelationships
** Type: array
** Description: return data structure from onCreateAddRelationships
* returnValue.firstObject
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* Status
** Type: string
** Description: status from create node // error or complete
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
relationship: {
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//…properties
}
},
firstNode: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: { //… identifiers },
fields: {
//… all fields
}
},
onCreateAddRelationships: [
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//… identifiers
},
fields: {
//… all fields
}
},
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//… all properties
}
}
]
},
secondNode: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: { //… identifiers },
fields: {
//… all fields
}
},
onCreateAddRelationships: [
//… optional
]
}
}
}
}
requestParams: {
// return example send param

},
Status: 'string', //“complete” // “error”
errorsFound: []
}
}
</syntaxhighlight>

== GetRelationship ==
=== Request Parameters ===
* firstObject
** Type: object
** Required: optional
* secondObject
** Type: object
** Required: optional
* objType
** Type: object
** Required: true
** Description: has serviceTag and objectType
* identifiers
** Type: object
** Required: true
* relType
** Type: object
** Required: true
** Description: has relationshipTag and serviceTag
* relId
** Type: string
** Required: true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag":string,
"objectType":string
},
"identifiers":{
//…identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"relType":{ // required
"relationshipTag": string,
"serviceTag": string
},
"relId": 'string' // // required
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
* Type: object
* queryResult.relType
** Type: object
* queryResult.relationshipProperties
** Type: object
** Description: return relId and properties
* returnValue.toObject
** Type: object
** Description: return toObject if not send secondObject from param
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* errorsFound
** Type: array
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: {
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//…properties : 'string’
}
},
toObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: {
identifiers: {
//
},
fields: { }
}
},
requestParams: {
// return example send param
}
}
}

</syntaxhighlight>

== UpdateRelationship ==
=== Request Parameters ===
* firstObject
** Type: object
** Required: optional
* secondObject
** Type: object
** Required: Optional
* objType
** Type: object
** Required: true
** Description: has serviceTag and objectType
* identifiers
** Type: object
** Required: true
* relId
** Type: string
** Required: true
* relType
** Type: object
** Required: true
** Description: has relationshipTag and serviceTag
* relationshipProperties
** Type: object
** Required: true
** Description: send properties that want to update
* relationshipDirection
** Type: string
** Required: optional
* callingFlow
** Type: string
** Required: optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"relId": string,
"relType":{
"serviceTag":string,
"relationshipTag":string
},
"relationshipProperties":{
//… properties that want to update
},
"relationshipDirection": string, // "from" // “to”
"callingFlow": string
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.firstObject And secondObject
** Type: object
** Description : return objType {seviceTag and objectType} And identifiers
* queryResult.relId
** Type: string
* queryResult.relType
** Type: object
** Description: return {seviceTag and relationshipTag}
* queryResult.relationshipDirection
** Type: string
* queryResult.updatePropertiesParam
** Type: object
** Description: return properties to updated
* queryResult.oldRelationshipProperties
** Type: object
** Description: return old properties before update
* queryResult.newRelationshipProperties
** Type: object
** Description: return new properties after updated
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type : string
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
firstObject: {
objType: {
serviceTag: "string",
objectType: "string"
},
identifiers: {
//…identifiers
}
},
secondObject: {
objType: {
serviceTag: "string",
objectType: "string"
},
identifiers: {
//…identifiers
}
},
relId: "string",
relType: {
serviceTag: "string",
relationshipTag: "string"
},
relationshipDirection: "string",
updatePropertiesParam: {
//… properties updated
},
oldRelationshipProperties: {
// … old properties before update
},
newRelationshipProperties: {
//… new properties after updated
}
}
},
requestParams: {
// return example send param
}
status: “string”, // "complete",”error”
errorsFound: []
}
</syntaxhighlight>

== GetNodeAndRelationship ==
=== Request Parameters ===
* sourceObjType
** Required: true
** Description: has serviceTag and objectType
* sourceIdentifiers
** Type: object
** Required: true
* sourceVersionedDataLabels
** Type: object
** Required: optional
* targetRelationships
** Type: Array
** Required: true
* relTypeAndDirection
** Type: object
** Required: true
* relTypeAndDirection.relType
** Type: object
** Required: true
** Description: has serviceTag and relationshipTag
* relTypeAndDirection.relationshipProperties
** Type: object
** Required: optional
* relTypeAndDirection.relationshipDirection
** Type: String
** Required: optional
* targetObjects
** Type: Array
** Required: Optional
* targetObjects.objType
** Type: object
** Required: required if send targetObjects in param
* targetObjects.identifiers
** Type: object
** Required: optional should have objType if identifiers exists
* targetObjects.versionedDataLabels
** Type: object
** Required: optional have objType if versionedDataLabels exists

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"sourceObjType": { // required
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"sourceIdentifiers": {}, // required
"sourceVersionedDataLabels": [], // optional
"targetRelationships": [ //required
{
"relTypeAndDirection": { // required
"relType": {
"serviceTag": "xxxx",
"relationshipTag": "rel"
},
"relationshipProperties": {},//optional
"relationshipDirection": "" // required
},
"targetObjects": [ // optional
{
"objType": {
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"identifiers": {}, // optional
"versionedDataLabels": [] // optional have objType if versionedDataLabels exists
}
]
},
// if have multiple relTypeAndDirection
],
"settings": {} // defaulf = false >>> if have versionedDataLabels want to return all field of versionedata: settings = { returnSystemFieldsName: true }
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.objTypes
** Type: array of object
** Description: return {serviceTag and objectType}
* queryResult.objInstanceFull
** Type: object
** Description: return {identifiers and fields}
* queryResult.relNodes:
** Type: array
* relNodes.relType
** Type: object
** Description: return {serviceTag and relationshipTag}
* relNodes.relationshipProperties
** Type: object
* relNodes.objTypes
** Type: array of object
** Description: return {serviceTag and objectType}
* relNodes.objInstanceFull
** Type: object
** Description: return {identifiers and fields}
* requestParams
** Type: object
** Description: return same requestParams
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: {},
fields: { }
},
relNodes: [
{
relType: {
serviceTag: 'xxxx',
relationshipTag: 'rel'
},
relationshipProperties: { },
objTypes: [
{
serviceTag: 'xxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: {},
fields: {
// field
}
},
versionDataSystemFields: {
'0VersionDataLabel': {
originTimestamp:
forMatchedId:
versionedDataId:
}
}
}
]
}
},
requestParam : {
// return example send param
},
errorsFound: [],
graphServiceTag: "GraphHandler"
}

</syntaxhighlight>

== ChangeRelationshipType ==
=== Request Parameters ===
* firstObject
** Type : object
** Required : true
* secondObject
** Type : object
** Required : true
* objType
** Type : object
** Required : true
* Identifiers
** Type : object
** Required : true
* oldRelTypeAndDirection
** Type : object
** Required : true
* oldRelTypeAndDirection.relType
** Type : object
** Required : true
* oldRelTypeAndDirection.relationshipDirection
** Type : string
** Required : true
* oldRelTypeAndDirection.relationshipProperties
** Type : object
** Required : optional
* newRelType
** Type : object
** Required : true
* originTimestamp
** Type : number
** Required : true
* changedByUserId
** Type : String
** Required : true
* callingFlow
** Type : String
** Required : optional
* settings
** Type : object
** Required : optional
** Description : default > settings.changeMultipleRelationships : false // if send settings.changeMultipleRelationships : true >> can change multiple relType

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"secondObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"oldRelTypeAndDirection":{
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"old"
},
"relationshipDirection":"from",
"relationshipProperties":{
//Properties
}
},
"newRelType":{
"serviceTag":"xxxx",
"relationshipTag":"new"
},
"originTimestamp":1234567890,
"changedByUserId":"xxxx",
"callingFlow":"yyyy",
"settings":{
"changeMultipleRelationships": boolean: // default false
}
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.newRelationshipType
** Type: object
* newRelationshipType.relType
** Type: object
* newRelationshipType.relationshipDirection
** Type: string
* newRelationshipType.relationshipProperties
** Type: object
* queryResult.oldRelationshipType
** Type: object
* oldRelationshipType.relType
** Type: object
* oldRelationshipType.relationshipDirection
** Type: string
* oldRelationshipType.relationshipProperties
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
newRelationshipType: {
relType: {
serviceTag: "xxxx",
relationshipTag: "new"
},
relationshipDirection: "" // 'from' or 'to'
relationshipProperties: {}
},
oldRelationshipType: {
relType: {
serviceTag: "xxxx",
relationshipTag: "old"
},
relationshipDirection: "" // 'from' or 'to'
relationshipProperties: {}
}
},
requestParams : {
// return example send param
}
},
status: "complete" // or error,
errorsFound: [],
graphServiceTag : 'GraphHandeler'
}

</syntaxhighlight>

== DeleteRelationship ==
=== Request Parameters ===
* fromObject
** Type : object
** Required : optional
* secondObject
** Type : object
** Required : optional
* objType
** Type : object
** Required : true
* Identifiers
** Type : object
** Required : true
* relType
** Type : object
** Required : true
* relId
** Type: string
** Required : true
* relationshipDirection
** Type: string
** Required : optional
* callingFlow
** Type: string
** Required : true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"yyyy"
},
"relId":"string"
},
"relationshipDirection":"string"// "from" or "to"
"callingFlow":"string"
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.objects
** Type: array
* queryResult.objTypes
** Type: array
* queryResult.objInstanceFull.identifiers
** Type: object
* queryResult.objInstanceFull.fields
** Type: object
** Description: return data of fromObject and secondObject
* queryResult.userNode
** Type: object
** Description: return data of userNode
* queryResult.resultDeleteRel
** Type : string
** Description: return status Relationship Delete
* requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objects: [
{
objTypes: [
{
serviceTag: "xxxx",
objectType: "yyyy"
}
],
objInstanceFull: {
identifiers: {
// identifiers
},
fields: {
// fields
}
}
},
{
// if have multiple object objTypes
}
],
userNode: {
objTypes: [
{
serviceTag: "UserAccount",
objectType: "user"
}
],
objInstanceFull: {
identifiers: {
userId: "zzz"
}
}
},
resultDeleteRel: "Relationship Deleted" // default
},
requeatParam: {
// return example send param
},
status: "string", //default "complete" or "error"
errorsFound: []
}
}

</syntaxhighlight>

== DeleteNode ==
=== Request Parameters ===
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* identifiers
** Type : object
** Required: true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":"xxx",
"objectType":"yyy"
},
"identifiers":{
//
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResults
** Type: object
* queryResults.resultDeleteNode
** Type: Boolean
** Description: return status deleted node >> true or false
* requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
** Description: return status deleted node >> complete or error
* errorsFound
** Type: array
* graphServiceTag
** Type: string
=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: { resultDeleteNode: true }, // true or false
requestParams: {
// return example send param
}
},
status: 'string', // 'complete' or 'error'
errorsFound: [],
graphServiceTag: 'GraphHandler'
}
</syntaxhighlight>

== MoveRelationship ==

=== Request Parameters ===
* sourceObject
** Type : object
** Required : true
** Description: required objType: {serviceTag , objectType} and identifiers
* targetObjType
** Type : object
** Required : true
** Description: required objType: {serviceTag , objectType}
* relType
** Type : object
** Required : true
** Description: required objType: {serviceTag , relationshipTag}
* relationshipDirection
** Type : object
** Required : true
* moveToIdentifiers
** Type : object
** Required : true
* moveByUserId
** Type : String
** Required : true
* originTimestamp
** Type : number
** Required : true
* settings
** Type : object
** Required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"sourceObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyy"
},
"identifiers":{
// identifiers
}
},
"targetObjType":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
}
},
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"rel"
},
"relationshipDirection":"from", // "to"
"moveToIdentifiers":{
// target identifiers
},
"moveByUserId":"xxxx",
"originTimestamp":1234567890,
"settings":{}
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.moveRelationship
** Type: object
* moveRelationship.sourceObject
** Type: object
** Description: return data of sourceObject
* moveRelationship.relationship
** Type: string
** Description: return data of after move relationship
* moveRelationship.moveToObject
** Type: object
** Description: return data of moveToObject
* moveRelationship.historyData
** Type: object
** Description: return properties {old target identifiers and originTimestamp} after moveRelationship
* moveRelationship.userNode
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
moveRelationship: {
sourceObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
}
},
relationship: {
relType: {
serviceTag: 'xxxx',
relationshipTag: 'rel'
},
relationshipProperties: { originTimestamp: 1234567890 }
},
moveToObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: { }
},
historyData: {
relationshipProperties: { }
},
userNode: {
objTypes: [{ serviceTag: 'UserAccount', objectType: 'user' }],
objInstanceFull: { }
}
}
},
requestParam: {
}
}
status: "complete" // or error,
errorsFound: [],
graphServiceTag: 'GraphHandler'
}

</syntaxhighlight>

== MoveNodeProperties ==
=== Request Parameters ===
* sourceObject
** type: object
** required : true
* targetIdentifiers
** type : object
** required : true
* moveProperties
** type : array
** required : true // index minimum = 1
* updateProperties
** type : object
** required : true
* movePropertiesConditions
** type : array
** required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
sourceObject: {
objType: { },
identifier: { }
},
targetIdentifiers: { },
moveProperties: [ ],
updateProperties: { },
movePropertiesConditions: [ // optional
{
checkObject: 'target', // "source" | "target"
onSetObject: 'target', // "source" | "target"
onPassValue: true,
onNotPassCondition: false, // optional
fieldNameConditions: [ ]
}
]
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.moveNodeProperties
** Type: object
* moveNodeProperties.sourceObject
** Type: object
** Description: return data of sourceObject
* moveRelationship.moveFieldToObject
** Type: string
** Description: return data after moveFieldToObject
* moveRelationship.movedFields
** Type: object
** Description: return data field of moveToObject
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String
=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
moveNodeProperties: {
sourceObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: {
identifiers: { },
fields: { }
}
},
moveFieldToObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: { },
fields: {

}
},
movedFields: { Fields: { } } //
}
}
},
requestParam: { },
status: 'complete',
errorsFound: [],
graphServiceTag: 'GraphHandler'
}
</syntaxhighlight>
[[Category:Working documents| 2025-03-06]]

2025-03-06 - Graph Handler Docs

2026-06-03T05:56:35Z

Seagame: /* Request Example */

= GraphHandler Function =
== CreateNode ==
'''Use Case of CreateNode''' >>> https://izara.io/wiki/index.php/2025-03-27_Graph_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
* setFieldConditionals
** type : array
** Required : optional
* deepPathConditional
** type : array
** Required : optional
* parentFlowId
** type : string
** Required: true
* callingFlowConfig
** Type: object
** Required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType": {
"objectType": string,
"serviceTag": string
},
"objInstanceFull": {
"identifiers": {
// ...identifier
},
"fields": {
// ...fields
}
},
setFieldConditionals: [ // optional default array
{
objType: { },
indexValue: { nameSpace: 'ex-011', systemTextTag: 'Gate-011' }, // index field : value
fieldName: '', // fieldName want to set
passValue: 'false', optional
notPassValue: 'true', //optional
conditionals: [ optional ] // condition check field
}
],
"relationships": [
{
"relType": {
"serviceTag": string,
"relationshipTag": string
},
"relationshipProperties": {
//... key and value of targetIdentifiers
},
"relationshipDirection": string, // "from" | "to"
"targetObjType": {
"serviceTag": string,
"objectType": string
},
"targetIdentifiers": {
//... targetIdentifiers
}
}
],
deepPathConditional: [ // optional default array
{
condition: 'notExist', //
conditionCheck: { // traversal
nodeStructure: {
objType: { },
fields: { }
},
nextPath: {
relationshipStructure: {
relType: { },
relationshipDirection: 'to'
},
nodeStructure: {
objType: { },
fields: { }
}
}
}
}
],
"originTimestamp": number, // timestamp when create
"settings": {
"updatePropertiesOnMatch": boolean // default=false
},
"parentFlowId": "", // required
"callingFlow": string,
"callingFlowProperties": object,
}
</syntaxhighlight>

=== 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.relationships
** Type: array
** Description: data from relationships in targetNode
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* Status
** Type: string
** Description: Status from create node. Return "error" or "complete".
* errorsFound
** Type: array
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">

{
returnValue: {
queryResult: {
returnCreateNode: {
objTypes: [
{
serviceTag: "string",
objectType: "string"
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//...fields
}
},
existsNode: { },
userNode: { // // if has userNode send to createNode
objTypes: [
{
"serviceTag": "UserAccount",
"objectType": "user"
}
],
properties: {
//...properties
}
},
relationships: [ // optional : if has requiredOnCreated , createNode with targetNode
{
objTypes: [
{ serviceTag: 'string', objectType: 'string' }
],
objInstanceFull: {
identifiers: {
// identifiers
}
},
relType: {
serviceTag: 'string',
relationshipTag: 'rel'
},
relationshipProperties: {
// properties
}
},
]
}
},
requestParams: {
// return example send param
},
parentFlowId:""
},
status: "string", // "complete' or "error"
errorsFound: [],
graphServiceTag: "GraphHandler"
}

</syntaxhighlight>

== GetNode ==
'''Use Case of GetNode''' >>> https://izara.io/wiki/index.php/2025-04-23_Graph_Use_Case/GetNode_and_GetNodes#Use_Case_GetNodes
=== 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
* versionedDataLabels
** Type: Array
** Required : optional
* settings.updatePropertiesOnMatch
** Type: Boolean
** Required : optional
* parentFlowId
** Type: string
** Required: optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":string,
"objectType":string
},
"objInstanceFull":{
"identifiers":{
// ...identifier
},
"fields":{
// ...fields
}
},
"versionedDataLabels":[
//…versionedData
],
"settings": {
"returnSystemFieldsName" :boolean // default = true or false
},
"parentFlowId" : "" // optional
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* returnValue.queryResult
** Type: object
* queryResult.refactoredNodes
** Type: object
** Description: return object from getNode
* refactoredNodes.objTypes
** Type: array
* refactoredNodes.objInstanceFull
** Type: object
* refactoredNodes.objInstanceFull.identifiers
** Type: object
* refactoredNodes.objInstanceFull.fields
** Type: object
* refactoredNodes.versionDataSystemFields
** Type: object
* refactoredNodes.versionDataSystemFields.versionedDataLabel
** Type: object
* queryResult.requestParam
** Type: object
** Description: return example send param
* errorsFound
** Type: string
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
refactoredNodes: {
objTypes: [
{
serviceTag: "string",
objectType: "string",
}
],
objInstanceFull: {
identifiers: {
//… identifier
},
fields: {
//…fields
}
},
versionDataSystemFields: {
versionedDataLabel: {
originTimestamp: number,
forMatchedId: "string",
versionedDataId: "string"
}
}
}
},
requestParam: {
// return example send param
}
},
errorsFound: [],
graphServiceTag: ''
}
</syntaxhighlight>

== GetNodes ==
'''Use Case of GetNodes''' >>> https://izara.io/wiki/index.php/2025-04-23_Graph_Use_Case/GetNode_and_GetNodes#Use_Case_GetNodes
=== Request Parameters ===
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* fields
** Type : object
** Required: true
* versionedDataLabels
** Type: Array
** Required : optional
* settings.returnSystemFieldsName
** Type: Boolean
** Required : optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":string,
"objectType":string
},
"fields":{
//…fields with matching value
},
"versionedDataLabels":[
//…versionedDataLabels
],
"settings":{
"returnSystemFieldsName":boolean // default=false
},
"parentFlowId" :"" // optional
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResults
** Type: object
* queryResults.getNodesReturnValues
** Type: array
* getNodesReturnValues.objTypes
** Type: array
* getNodesReturnValues.objInstanceFull
** Type: object
* getNodesReturnValues.objInstanceFull.identifiers
** Type: object
* getNodesReturnValues.objInstanceFull.fields
** Type: object
* getNodesReturnValues.versionDataSystemFields
** Type: object
* getNodesReturnValues.versionDataSystemFields.versionedDataLabel
** Type: object
* requestParams
** Type: object
* errorsFound
** Type: string
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: {
getNodesReturnValues: [
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//.. all fields-1
}
},
versionDataSystemFields: {}
},
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//...all fields-2
}
},
versionDataSystemFields: {
versionedDataLabel: {
originTimestamp: number,
forMatchedId: 'string',
versionedDataId: 'string'
}
}
}
]
},
requestParams: {
// return example send param
}
}
}
</syntaxhighlight>

== UpdateNode ==
''' Use Case of UpdateNode''' >>> https://izara.io/wiki/index.php/2025-08-03_-_Graph_Use_Case/UpdateNode
=== 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: object
** Required : true
* objInstanceFull.fields
** Type : object
** Required: true
** Description : can not send fields to update mainNode and versionedData together
* versionedDataIds
** Type: object
** Required: optional
* originTimestamp
** Type: number
** Required: true
* settings
** Type: object
** Required: optional
* callingFlow
** Type: string
** Required: optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType": {
"serviceTag": string,
"objectType": string
},
"objInstanceFull": {
"identifiers": {
//…identifiers
},
"fields": {
//…fields
// can not be send fields of mainNode and versionedData in fields together!
}
},
"versionedDataIds": {},
"originTimestamp": number, //// timestamp when update
"settings": {},
"parentFlowId": ""// required
"callingFlow": string
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* returnValue.queryResult
** Type: object
** Description: data from created node
* queryResult.objTypes
** Type: array
** Description: serviceTag and objectType
* queryResult.objInstanceFull
** Type: object
** Description: identifiers and fields
* queryResult.userId
** Type: object
** Description: data that update from user Account
* queryResult.versionDataSystemFields
** Type: object
** Description: optional return versionedData
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* returnValue.Status
** Type: string
** Description: status from updated node // error or complete
* returnValue.errorsFound
** Type: array
* returnValue.graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifiers
},
fields: {
//...fields
}
},
userId: {
// if have userNode send to updated
},
versionDataSystemFields: {
versionedDataLabel: {
}
}
},
requestParams: {
// return example send param
}
},
status: 'string',//"complete" // "error"
errorsFound: [],
graphServiceTag: 'string'
}
</syntaxhighlight>

== CreateRelationship ==
''' Use Case of CreateRelationship''' >>> https://izara.io/wiki/index.php/2025-08-01_-_Graph_Use_Case/CreateRelationship
=== Request Parameters ===
* firstObject
** Type: object
** Required: true
* secondObject
** Type: object
** Required: true
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* identifiers
** Type: object
** Required : true
* createRelationshipIfNothave
** Type : array
** Required: optional
** Description : using createRelationshipIfNothave for check relationship if not has created , can check both firstNode and SeconNode or onCreateAddRelationships
* onCreateAddRelationships
** Type: array of object
** Required: optional
* relType
** Type: object
** Required: true
* relationshipDirection
** Type: string
** Required: true
* relationshipProperties
** Type: object
** Required: true
* Settings
** Type: object
** Required: true
* settings.updateRelPropsWhenExist
** Type: boolean
** Required: optional
* callingFlow
** Type: string
** Required: optional
* callingFlowConfig
** Type: object
** Required: optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject": {
"objType": {
"serviceTag": string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"createRelationshipIfNothave": [ // optional
{
"onMatchRelationship": {
"relType": {
"serviceTag": string,
"relationshipTag": string
},
"relationshipProperties": {},
"relationshipDirection": string
},
"onMatchNode": {
"objType": {
"serviceTag":string,
"objectType": string
},
"fields": {
}
}
}
],
"onCreateAddRelationships": [
{
"objType": {
"serviceTag":string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"relType": {
"serviceTag":string,
"relationshipTag":string
},
"relationshipProperties": {
//…properties
},
"relationshipDirection":string // “from” , “to”
}
]
},
"secondObject": {
"objType": {
"serviceTag":string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"onCreateAddRelationships": [
//…optional
]
},
"relType": {
"serviceTag":string,
"relationshipTag":string
},
"relationshipDirection":string, // “from” , “to”
"relationshipProperties": {
//…properties
},
"settings": {
"updateRelPropsWhenExist": boolean,
},
"callingFlow": "xxxx",
"callingFlowProperties": {
"graphServiceName": string
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.relationship
** Type: object
* queryResult.relationship.relType
** Type: object
* queryResult.relationship.relationshipProperties
** Type: object
* queryResult.firstNode
** Type: object
** Description: return data structure from firstNode
* queryResult.secondNode
** Type: object
** Description: return data structure from secondNode
* queryResult..onCreateAddRelationships
** Type: array
** Description: return data structure from onCreateAddRelationships
* returnValue.firstObject
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* Status
** Type: string
** Description: status from create node // error or complete
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
relationship: {
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//…properties
}
},
firstNode: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: { //… identifiers },
fields: {
//… all fields
}
},
onCreateAddRelationships: [
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//… identifiers
},
fields: {
//… all fields
}
},
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//… all properties
}
}
]
},
secondNode: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: { //… identifiers },
fields: {
//… all fields
}
},
onCreateAddRelationships: [
//… optional
]
}
}
}
}
requestParams: {
// return example send param

},
Status: 'string', //“complete” // “error”
errorsFound: []
}
}
</syntaxhighlight>

== GetRelationship ==
=== Request Parameters ===
* firstObject
** Type: object
** Required: optional
* secondObject
** Type: object
** Required: optional
* objType
** Type: object
** Required: true
** Description: has serviceTag and objectType
* identifiers
** Type: object
** Required: true
* relType
** Type: object
** Required: true
** Description: has relationshipTag and serviceTag
* relId
** Type: string
** Required: true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag":string,
"objectType":string
},
"identifiers":{
//…identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"relType":{ // required
"relationshipTag": string,
"serviceTag": string
},
"relId": 'string' // // required
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
* Type: object
* queryResult.relType
** Type: object
* queryResult.relationshipProperties
** Type: object
** Description: return relId and properties
* returnValue.toObject
** Type: object
** Description: return toObject if not send secondObject from param
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* errorsFound
** Type: array
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: {
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//…properties : 'string’
}
},
toObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: {
identifiers: {
//
},
fields: { }
}
},
requestParams: {
// return example send param
}
}
}

</syntaxhighlight>

== UpdateRelationship ==
=== Request Parameters ===
* firstObject
** Type: object
** Required: optional
* secondObject
** Type: object
** Required: Optional
* objType
** Type: object
** Required: true
** Description: has serviceTag and objectType
* identifiers
** Type: object
** Required: true
* relId
** Type: string
** Required: true
* relType
** Type: object
** Required: true
** Description: has relationshipTag and serviceTag
* relationshipProperties
** Type: object
** Required: true
** Description: send properties that want to update
* relationshipDirection
** Type: string
** Required: optional
* callingFlow
** Type: string
** Required: optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"relId": string,
"relType":{
"serviceTag":string,
"relationshipTag":string
},
"relationshipProperties":{
//… properties that want to update
},
"relationshipDirection": string, // "from" // “to”
"callingFlow": string
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.firstObject And secondObject
** Type: object
** Description : return objType {seviceTag and objectType} And identifiers
* queryResult.relId
** Type: string
* queryResult.relType
** Type: object
** Description: return {seviceTag and relationshipTag}
* queryResult.relationshipDirection
** Type: string
* queryResult.updatePropertiesParam
** Type: object
** Description: return properties to updated
* queryResult.oldRelationshipProperties
** Type: object
** Description: return old properties before update
* queryResult.newRelationshipProperties
** Type: object
** Description: return new properties after updated
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type : string
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
firstObject: {
objType: {
serviceTag: "string",
objectType: "string"
},
identifiers: {
//…identifiers
}
},
secondObject: {
objType: {
serviceTag: "string",
objectType: "string"
},
identifiers: {
//…identifiers
}
},
relId: "string",
relType: {
serviceTag: "string",
relationshipTag: "string"
},
relationshipDirection: "string",
updatePropertiesParam: {
//… properties updated
},
oldRelationshipProperties: {
// … old properties before update
},
newRelationshipProperties: {
//… new properties after updated
}
}
},
requestParams: {
// return example send param
}
status: “string”, // "complete",”error”
errorsFound: []
}
</syntaxhighlight>

== GetNodeAndRelationship ==
=== Request Parameters ===
* sourceObjType
** Required: true
** Description: has serviceTag and objectType
* sourceIdentifiers
** Type: object
** Required: true
* sourceVersionedDataLabels
** Type: object
** Required: optional
* targetRelationships
** Type: Array
** Required: true
* relTypeAndDirection
** Type: object
** Required: true
* relTypeAndDirection.relType
** Type: object
** Required: true
** Description: has serviceTag and relationshipTag
* relTypeAndDirection.relationshipProperties
** Type: object
** Required: optional
* relTypeAndDirection.relationshipDirection
** Type: String
** Required: optional
* targetObjects
** Type: Array
** Required: Optional
* targetObjects.objType
** Type: object
** Required: required if send targetObjects in param
* targetObjects.identifiers
** Type: object
** Required: optional should have objType if identifiers exists
* targetObjects.versionedDataLabels
** Type: object
** Required: optional have objType if versionedDataLabels exists

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"sourceObjType": { // required
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"sourceIdentifiers": {}, // required
"sourceVersionedDataLabels": [], // optional
"targetRelationships": [ //required
{
"relTypeAndDirection": { // required
"relType": {
"serviceTag": "xxxx",
"relationshipTag": "rel"
},
"relationshipProperties": {},//optional
"relationshipDirection": "" // required
},
"targetObjects": [ // optional
{
"objType": {
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"identifiers": {}, // optional
"versionedDataLabels": [] // optional have objType if versionedDataLabels exists
}
]
},
// if have multiple relTypeAndDirection
],
"settings": {} // defaulf = false >>> if have versionedDataLabels want to return all field of versionedata: settings = { returnSystemFieldsName: true }
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.objTypes
** Type: array of object
** Description: return {serviceTag and objectType}
* queryResult.objInstanceFull
** Type: object
** Description: return {identifiers and fields}
* queryResult.relNodes:
** Type: array
* relNodes.relType
** Type: object
** Description: return {serviceTag and relationshipTag}
* relNodes.relationshipProperties
** Type: object
* relNodes.objTypes
** Type: array of object
** Description: return {serviceTag and objectType}
* relNodes.objInstanceFull
** Type: object
** Description: return {identifiers and fields}
* requestParams
** Type: object
** Description: return same requestParams
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: {},
fields: { }
},
relNodes: [
{
relType: {
serviceTag: 'xxxx',
relationshipTag: 'rel'
},
relationshipProperties: { },
objTypes: [
{
serviceTag: 'xxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: {},
fields: {
// field
}
},
versionDataSystemFields: {
'0VersionDataLabel': {
originTimestamp:
forMatchedId:
versionedDataId:
}
}
}
]
}
},
requestParam : {
// return example send param
},
errorsFound: [],
graphServiceTag: "GraphHandler"
}

</syntaxhighlight>

== ChangeRelationshipType ==
=== Request Parameters ===
* firstObject
** Type : object
** Required : true
* secondObject
** Type : object
** Required : true
* objType
** Type : object
** Required : true
* Identifiers
** Type : object
** Required : true
* oldRelTypeAndDirection
** Type : object
** Required : true
* oldRelTypeAndDirection.relType
** Type : object
** Required : true
* oldRelTypeAndDirection.relationshipDirection
** Type : string
** Required : true
* oldRelTypeAndDirection.relationshipProperties
** Type : object
** Required : optional
* newRelType
** Type : object
** Required : true
* originTimestamp
** Type : number
** Required : true
* changedByUserId
** Type : String
** Required : true
* callingFlow
** Type : String
** Required : optional
* settings
** Type : object
** Required : optional
** Description : default > settings.changeMultipleRelationships : false // if send settings.changeMultipleRelationships : true >> can change multiple relType

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"secondObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"oldRelTypeAndDirection":{
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"old"
},
"relationshipDirection":"from",
"relationshipProperties":{
//Properties
}
},
"newRelType":{
"serviceTag":"xxxx",
"relationshipTag":"new"
},
"originTimestamp":1234567890,
"changedByUserId":"xxxx",
"callingFlow":"yyyy",
"settings":{
"changeMultipleRelationships": boolean: // default false
}
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.newRelationshipType
** Type: object
* newRelationshipType.relType
** Type: object
* newRelationshipType.relationshipDirection
** Type: string
* newRelationshipType.relationshipProperties
** Type: object
* queryResult.oldRelationshipType
** Type: object
* oldRelationshipType.relType
** Type: object
* oldRelationshipType.relationshipDirection
** Type: string
* oldRelationshipType.relationshipProperties
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
newRelationshipType: {
relType: {
serviceTag: "xxxx",
relationshipTag: "new"
},
relationshipDirection: "" // 'from' or 'to'
relationshipProperties: {}
},
oldRelationshipType: {
relType: {
serviceTag: "xxxx",
relationshipTag: "old"
},
relationshipDirection: "" // 'from' or 'to'
relationshipProperties: {}
}
},
requestParams : {
// return example send param
}
},
status: "complete" // or error,
errorsFound: [],
graphServiceTag : 'GraphHandeler'
}

</syntaxhighlight>

== DeleteRelationship ==
=== Request Parameters ===
* fromObject
** Type : object
** Required : optional
* secondObject
** Type : object
** Required : optional
* objType
** Type : object
** Required : true
* Identifiers
** Type : object
** Required : true
* relType
** Type : object
** Required : true
* relId
** Type: string
** Required : true
* relationshipDirection
** Type: string
** Required : optional
* callingFlow
** Type: string
** Required : true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"yyyy"
},
"relId":"string"
},
"relationshipDirection":"string"// "from" or "to"
"callingFlow":"string"
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.objects
** Type: array
* queryResult.objTypes
** Type: array
* queryResult.objInstanceFull.identifiers
** Type: object
* queryResult.objInstanceFull.fields
** Type: object
** Description: return data of fromObject and secondObject
* queryResult.userNode
** Type: object
** Description: return data of userNode
* queryResult.resultDeleteRel
** Type : string
** Description: return status Relationship Delete
* requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objects: [
{
objTypes: [
{
serviceTag: "xxxx",
objectType: "yyyy"
}
],
objInstanceFull: {
identifiers: {
// identifiers
},
fields: {
// fields
}
}
},
{
// if have multiple object objTypes
}
],
userNode: {
objTypes: [
{
serviceTag: "UserAccount",
objectType: "user"
}
],
objInstanceFull: {
identifiers: {
userId: "zzz"
}
}
},
resultDeleteRel: "Relationship Deleted" // default
},
requeatParam: {
// return example send param
},
status: "string", //default "complete" or "error"
errorsFound: []
}
}

</syntaxhighlight>

== DeleteNode ==
=== Request Parameters ===
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* identifiers
** Type : object
** Required: true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":"xxx",
"objectType":"yyy"
},
"identifiers":{
//
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResults
** Type: object
* queryResults.resultDeleteNode
** Type: Boolean
** Description: return status deleted node >> true or false
* requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
** Description: return status deleted node >> complete or error
* errorsFound
** Type: array
* graphServiceTag
** Type: string
=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: { resultDeleteNode: true }, // true or false
requestParams: {
// return example send param
}
},
status: 'string', // 'complete' or 'error'
errorsFound: [],
graphServiceTag: 'GraphHandler'
}
</syntaxhighlight>

== MoveRelationship ==

=== Request Parameters ===
* sourceObject
** Type : object
** Required : true
** Description: required objType: {serviceTag , objectType} and identifiers
* targetObjType
** Type : object
** Required : true
** Description: required objType: {serviceTag , objectType}
* relType
** Type : object
** Required : true
** Description: required objType: {serviceTag , relationshipTag}
* relationshipDirection
** Type : object
** Required : true
* moveToIdentifiers
** Type : object
** Required : true
* moveByUserId
** Type : String
** Required : true
* originTimestamp
** Type : number
** Required : true
* settings
** Type : object
** Required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"sourceObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyy"
},
"identifiers":{
// identifiers
}
},
"targetObjType":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
}
},
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"rel"
},
"relationshipDirection":"from", // "to"
"moveToIdentifiers":{
// target identifiers
},
"moveByUserId":"xxxx",
"originTimestamp":1234567890,
"settings":{}
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.moveRelationship
** Type: object
* moveRelationship.sourceObject
** Type: object
** Description: return data of sourceObject
* moveRelationship.relationship
** Type: string
** Description: return data of after move relationship
* moveRelationship.moveToObject
** Type: object
** Description: return data of moveToObject
* moveRelationship.historyData
** Type: object
** Description: return properties {old target identifiers and originTimestamp} after moveRelationship
* moveRelationship.userNode
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
moveRelationship: {
sourceObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
}
},
relationship: {
relType: {
serviceTag: 'xxxx',
relationshipTag: 'rel'
},
relationshipProperties: { originTimestamp: 1234567890 }
},
moveToObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: { }
},
historyData: {
relationshipProperties: { }
},
userNode: {
objTypes: [{ serviceTag: 'UserAccount', objectType: 'user' }],
objInstanceFull: { }
}
}
},
requestParam: {
}
}
status: "complete" // or error,
errorsFound: [],
graphServiceTag: 'GraphHandler'
}

</syntaxhighlight>

== MoveNodeProperties ==
=== Request Parameters ===
* sourceObject
** type: object
** required : true
* targetIdentifiers
** type : object
** required : true
* moveProperties
** type : array
** required : true // index minimum = 1
* updateProperties
** type : object
** required : true
* movePropertiesConditions
** type : array
** required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
sourceObject: {
objType: { },
identifier: { }
},
targetIdentifiers: { },
moveProperties: [ ],
updateProperties: { },
movePropertiesConditions: [ // optional
{
checkObject: 'target', // "source" | "target"
onSetObject: 'target', // "source" | "target"
onPassValue: true,
onNotPassCondition: false, // optional
fieldNameConditions: [ ]
}
]
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.moveNodeProperties
** Type: object
* moveNodeProperties.sourceObject
** Type: object
** Description: return data of sourceObject
* moveRelationship.moveFieldToObject
** Type: string
** Description: return data after moveFieldToObject
* moveRelationship.movedFields
** Type: object
** Description: return data field of moveToObject
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String
=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
moveNodeProperties: {
sourceObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: {
identifiers: { },
fields: { }
}
},
moveFieldToObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: { },
fields: {

}
},
movedFields: { Fields: { } } //
}
}
},
requestParam: { },
status: 'complete',
errorsFound: [],
graphServiceTag: 'GraphHandler'
}
</syntaxhighlight>
[[Category:Working documents| 2025-03-06]]

2025-03-06 - Graph Handler Docs

2026-06-03T05:55:31Z

Seagame: /* Request Example */

= GraphHandler Function =
== CreateNode ==
'''Use Case of CreateNode''' >>> https://izara.io/wiki/index.php/2025-03-27_Graph_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
* setFieldConditionals
** type : array
** Required : optional
* deepPathConditional
** type : array
** Required : optional
* parentFlowId
** type : string
** Required: true
* callingFlowConfig
** Type: object
** Required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType": {
"objectType": string,
"serviceTag": string
},
"objInstanceFull": {
"identifiers": {
// ...identifier
},
"fields": {
// ...fields
}
},
setFieldConditionals: [ // optional default array
{
objType: { },
indexValue: { nameSpace: 'ex-011', systemTextTag: 'Gate-011' }, // index field : value
fieldName: '', // fieldName want to set
passValue: 'false', optional
notPassValue: 'true', //optional
conditionals: [ optional ] // condition check field
}
],
"relationships": [
{
"relType": {
"serviceTag": string,
"relationshipTag": string
},
"relationshipProperties": {
//... key and value of targetIdentifiers
},
"relationshipDirection": string, // "from" | "to"
"targetObjType": {
"serviceTag": string,
"objectType": string
},
"targetIdentifiers": {
//... targetIdentifiers
}
}
],
deepPathConditional: [ // optional default array
{
condition: 'notExist', //
conditionCheck: { // traversal
nodeStructure: {
objType: { },
fields: { }
},
nextPath: {
relationshipStructure: {
relType: { },
relationshipDirection: 'to'
},
nodeStructure: {
objType: { },
fields: { }
}
}
}
}
],
"originTimestamp": number, // timestamp when create
"settings": {
"updatePropertiesOnMatch": boolean // default=false
},
"parentFlowId": "", // required
"callingFlow": string,
"callingFlowProperties": object,
}
</syntaxhighlight>

=== 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.relationships
** Type: array
** Description: data from relationships in targetNode
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* Status
** Type: string
** Description: Status from create node. Return "error" or "complete".
* errorsFound
** Type: array
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">

{
returnValue: {
queryResult: {
returnCreateNode: {
objTypes: [
{
serviceTag: "string",
objectType: "string"
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//...fields
}
},
existsNode: { },
userNode: { // // if has userNode send to createNode
objTypes: [
{
"serviceTag": "UserAccount",
"objectType": "user"
}
],
properties: {
//...properties
}
},
relationships: [ // optional : if has requiredOnCreated , createNode with targetNode
{
objTypes: [
{ serviceTag: 'string', objectType: 'string' }
],
objInstanceFull: {
identifiers: {
// identifiers
}
},
relType: {
serviceTag: 'string',
relationshipTag: 'rel'
},
relationshipProperties: {
// properties
}
},
]
}
},
requestParams: {
// return example send param
},
parentFlowId:""
},
status: "string", // "complete' or "error"
errorsFound: [],
graphServiceTag: "GraphHandler"
}

</syntaxhighlight>

== GetNode ==
'''Use Case of GetNode''' >>> https://izara.io/wiki/index.php/2025-04-23_Graph_Use_Case/GetNode_and_GetNodes#Use_Case_GetNodes
=== 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
* versionedDataLabels
** Type: Array
** Required : optional
* settings.updatePropertiesOnMatch
** Type: Boolean
** Required : optional
* parentFlowId
** Type: string
** Required: optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":string,
"objectType":string
},
"objInstanceFull":{
"identifiers":{
// ...identifier
},
"fields":{
// ...fields
}
},
"versionedDataLabels":[
//…versionedData
],
"settings": {
"returnSystemFieldsName" :boolean // default = true or false
},
"parentFlowId" : "" // optional
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* returnValue.queryResult
** Type: object
* queryResult.refactoredNodes
** Type: object
** Description: return object from getNode
* refactoredNodes.objTypes
** Type: array
* refactoredNodes.objInstanceFull
** Type: object
* refactoredNodes.objInstanceFull.identifiers
** Type: object
* refactoredNodes.objInstanceFull.fields
** Type: object
* refactoredNodes.versionDataSystemFields
** Type: object
* refactoredNodes.versionDataSystemFields.versionedDataLabel
** Type: object
* queryResult.requestParam
** Type: object
** Description: return example send param
* errorsFound
** Type: string
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
refactoredNodes: {
objTypes: [
{
serviceTag: "string",
objectType: "string",
}
],
objInstanceFull: {
identifiers: {
//… identifier
},
fields: {
//…fields
}
},
versionDataSystemFields: {
versionedDataLabel: {
originTimestamp: number,
forMatchedId: "string",
versionedDataId: "string"
}
}
}
},
requestParam: {
// return example send param
}
},
errorsFound: [],
graphServiceTag: ''
}
</syntaxhighlight>

== GetNodes ==
'''Use Case of GetNodes''' >>> https://izara.io/wiki/index.php/2025-04-23_Graph_Use_Case/GetNode_and_GetNodes#Use_Case_GetNodes
=== Request Parameters ===
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* fields
** Type : object
** Required: true
* versionedDataLabels
** Type: Array
** Required : optional
* settings.returnSystemFieldsName
** Type: Boolean
** Required : optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":string,
"objectType":string
},
"fields":{
//…fields with matching value
},
"versionedDataLabels":[
//…versionedDataLabels
],
"settings":{
"returnSystemFieldsName":boolean // default=false
},
"parentFlowId" :"" // optional
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResults
** Type: object
* queryResults.getNodesReturnValues
** Type: array
* getNodesReturnValues.objTypes
** Type: array
* getNodesReturnValues.objInstanceFull
** Type: object
* getNodesReturnValues.objInstanceFull.identifiers
** Type: object
* getNodesReturnValues.objInstanceFull.fields
** Type: object
* getNodesReturnValues.versionDataSystemFields
** Type: object
* getNodesReturnValues.versionDataSystemFields.versionedDataLabel
** Type: object
* requestParams
** Type: object
* errorsFound
** Type: string
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: {
getNodesReturnValues: [
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//.. all fields-1
}
},
versionDataSystemFields: {}
},
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//...all fields-2
}
},
versionDataSystemFields: {
versionedDataLabel: {
originTimestamp: number,
forMatchedId: 'string',
versionedDataId: 'string'
}
}
}
]
},
requestParams: {
// return example send param
}
}
}
</syntaxhighlight>

== UpdateNode ==
''' Use Case of UpdateNode''' >>> https://izara.io/wiki/index.php/2025-08-03_-_Graph_Use_Case/UpdateNode
=== 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: object
** Required : true
* objInstanceFull.fields
** Type : object
** Required: true
** Description : can not send fields to update mainNode and versionedData together
* versionedDataIds
** Type: object
** Required: optional
* originTimestamp
** Type: number
** Required: true
* settings
** Type: object
** Required: optional
* callingFlow
** Type: string
** Required: optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType": {
"serviceTag": string,
"objectType": string
},
"objInstanceFull": {
"identifiers": {
//…identifiers
},
"fields": {
//…fields
// can not be send fields of mainNode and versionedData in fields together!
}
},
"versionedDataIds": {},
"originTimestamp": number, //// timestamp when update
"settings": {},
"callingFlow": string
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* returnValue.queryResult
** Type: object
** Description: data from created node
* queryResult.objTypes
** Type: array
** Description: serviceTag and objectType
* queryResult.objInstanceFull
** Type: object
** Description: identifiers and fields
* queryResult.userId
** Type: object
** Description: data that update from user Account
* queryResult.versionDataSystemFields
** Type: object
** Description: optional return versionedData
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* returnValue.Status
** Type: string
** Description: status from updated node // error or complete
* returnValue.errorsFound
** Type: array
* returnValue.graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifiers
},
fields: {
//...fields
}
},
userId: {
// if have userNode send to updated
},
versionDataSystemFields: {
versionedDataLabel: {
}
}
},
requestParams: {
// return example send param
}
},
status: 'string',//"complete" // "error"
errorsFound: [],
graphServiceTag: 'string'
}
</syntaxhighlight>

== CreateRelationship ==
''' Use Case of CreateRelationship''' >>> https://izara.io/wiki/index.php/2025-08-01_-_Graph_Use_Case/CreateRelationship
=== Request Parameters ===
* firstObject
** Type: object
** Required: true
* secondObject
** Type: object
** Required: true
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* identifiers
** Type: object
** Required : true
* createRelationshipIfNothave
** Type : array
** Required: optional
** Description : using createRelationshipIfNothave for check relationship if not has created , can check both firstNode and SeconNode or onCreateAddRelationships
* onCreateAddRelationships
** Type: array of object
** Required: optional
* relType
** Type: object
** Required: true
* relationshipDirection
** Type: string
** Required: true
* relationshipProperties
** Type: object
** Required: true
* Settings
** Type: object
** Required: true
* settings.updateRelPropsWhenExist
** Type: boolean
** Required: optional
* callingFlow
** Type: string
** Required: optional
* callingFlowConfig
** Type: object
** Required: optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject": {
"objType": {
"serviceTag": string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"createRelationshipIfNothave": [ // optional
{
"onMatchRelationship": {
"relType": {
"serviceTag": string,
"relationshipTag": string
},
"relationshipProperties": {},
"relationshipDirection": string
},
"onMatchNode": {
"objType": {
"serviceTag":string,
"objectType": string
},
"fields": {
}
}
}
],
"onCreateAddRelationships": [
{
"objType": {
"serviceTag":string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"relType": {
"serviceTag":string,
"relationshipTag":string
},
"relationshipProperties": {
//…properties
},
"relationshipDirection":string // “from” , “to”
}
]
},
"secondObject": {
"objType": {
"serviceTag":string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"onCreateAddRelationships": [
//…optional
]
},
"relType": {
"serviceTag":string,
"relationshipTag":string
},
"relationshipDirection":string, // “from” , “to”
"relationshipProperties": {
//…properties
},
"settings": {
"updateRelPropsWhenExist": boolean,
},
"callingFlow": "xxxx",
"callingFlowProperties": {
"graphServiceName": string
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.relationship
** Type: object
* queryResult.relationship.relType
** Type: object
* queryResult.relationship.relationshipProperties
** Type: object
* queryResult.firstNode
** Type: object
** Description: return data structure from firstNode
* queryResult.secondNode
** Type: object
** Description: return data structure from secondNode
* queryResult..onCreateAddRelationships
** Type: array
** Description: return data structure from onCreateAddRelationships
* returnValue.firstObject
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* Status
** Type: string
** Description: status from create node // error or complete
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
relationship: {
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//…properties
}
},
firstNode: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: { //… identifiers },
fields: {
//… all fields
}
},
onCreateAddRelationships: [
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//… identifiers
},
fields: {
//… all fields
}
},
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//… all properties
}
}
]
},
secondNode: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: { //… identifiers },
fields: {
//… all fields
}
},
onCreateAddRelationships: [
//… optional
]
}
}
}
}
requestParams: {
// return example send param

},
Status: 'string', //“complete” // “error”
errorsFound: []
}
}
</syntaxhighlight>

== GetRelationship ==
=== Request Parameters ===
* firstObject
** Type: object
** Required: optional
* secondObject
** Type: object
** Required: optional
* objType
** Type: object
** Required: true
** Description: has serviceTag and objectType
* identifiers
** Type: object
** Required: true
* relType
** Type: object
** Required: true
** Description: has relationshipTag and serviceTag
* relId
** Type: string
** Required: true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag":string,
"objectType":string
},
"identifiers":{
//…identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"relType":{ // required
"relationshipTag": string,
"serviceTag": string
},
"relId": 'string' // // required
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
* Type: object
* queryResult.relType
** Type: object
* queryResult.relationshipProperties
** Type: object
** Description: return relId and properties
* returnValue.toObject
** Type: object
** Description: return toObject if not send secondObject from param
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* errorsFound
** Type: array
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: {
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//…properties : 'string’
}
},
toObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: {
identifiers: {
//
},
fields: { }
}
},
requestParams: {
// return example send param
}
}
}

</syntaxhighlight>

== UpdateRelationship ==
=== Request Parameters ===
* firstObject
** Type: object
** Required: optional
* secondObject
** Type: object
** Required: Optional
* objType
** Type: object
** Required: true
** Description: has serviceTag and objectType
* identifiers
** Type: object
** Required: true
* relId
** Type: string
** Required: true
* relType
** Type: object
** Required: true
** Description: has relationshipTag and serviceTag
* relationshipProperties
** Type: object
** Required: true
** Description: send properties that want to update
* relationshipDirection
** Type: string
** Required: optional
* callingFlow
** Type: string
** Required: optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"relId": string,
"relType":{
"serviceTag":string,
"relationshipTag":string
},
"relationshipProperties":{
//… properties that want to update
},
"relationshipDirection": string, // "from" // “to”
"callingFlow": string
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.firstObject And secondObject
** Type: object
** Description : return objType {seviceTag and objectType} And identifiers
* queryResult.relId
** Type: string
* queryResult.relType
** Type: object
** Description: return {seviceTag and relationshipTag}
* queryResult.relationshipDirection
** Type: string
* queryResult.updatePropertiesParam
** Type: object
** Description: return properties to updated
* queryResult.oldRelationshipProperties
** Type: object
** Description: return old properties before update
* queryResult.newRelationshipProperties
** Type: object
** Description: return new properties after updated
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type : string
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
firstObject: {
objType: {
serviceTag: "string",
objectType: "string"
},
identifiers: {
//…identifiers
}
},
secondObject: {
objType: {
serviceTag: "string",
objectType: "string"
},
identifiers: {
//…identifiers
}
},
relId: "string",
relType: {
serviceTag: "string",
relationshipTag: "string"
},
relationshipDirection: "string",
updatePropertiesParam: {
//… properties updated
},
oldRelationshipProperties: {
// … old properties before update
},
newRelationshipProperties: {
//… new properties after updated
}
}
},
requestParams: {
// return example send param
}
status: “string”, // "complete",”error”
errorsFound: []
}
</syntaxhighlight>

== GetNodeAndRelationship ==
=== Request Parameters ===
* sourceObjType
** Required: true
** Description: has serviceTag and objectType
* sourceIdentifiers
** Type: object
** Required: true
* sourceVersionedDataLabels
** Type: object
** Required: optional
* targetRelationships
** Type: Array
** Required: true
* relTypeAndDirection
** Type: object
** Required: true
* relTypeAndDirection.relType
** Type: object
** Required: true
** Description: has serviceTag and relationshipTag
* relTypeAndDirection.relationshipProperties
** Type: object
** Required: optional
* relTypeAndDirection.relationshipDirection
** Type: String
** Required: optional
* targetObjects
** Type: Array
** Required: Optional
* targetObjects.objType
** Type: object
** Required: required if send targetObjects in param
* targetObjects.identifiers
** Type: object
** Required: optional should have objType if identifiers exists
* targetObjects.versionedDataLabels
** Type: object
** Required: optional have objType if versionedDataLabels exists

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"sourceObjType": { // required
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"sourceIdentifiers": {}, // required
"sourceVersionedDataLabels": [], // optional
"targetRelationships": [ //required
{
"relTypeAndDirection": { // required
"relType": {
"serviceTag": "xxxx",
"relationshipTag": "rel"
},
"relationshipProperties": {},//optional
"relationshipDirection": "" // required
},
"targetObjects": [ // optional
{
"objType": {
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"identifiers": {}, // optional
"versionedDataLabels": [] // optional have objType if versionedDataLabels exists
}
]
},
// if have multiple relTypeAndDirection
],
"settings": {} // defaulf = false >>> if have versionedDataLabels want to return all field of versionedata: settings = { returnSystemFieldsName: true }
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.objTypes
** Type: array of object
** Description: return {serviceTag and objectType}
* queryResult.objInstanceFull
** Type: object
** Description: return {identifiers and fields}
* queryResult.relNodes:
** Type: array
* relNodes.relType
** Type: object
** Description: return {serviceTag and relationshipTag}
* relNodes.relationshipProperties
** Type: object
* relNodes.objTypes
** Type: array of object
** Description: return {serviceTag and objectType}
* relNodes.objInstanceFull
** Type: object
** Description: return {identifiers and fields}
* requestParams
** Type: object
** Description: return same requestParams
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: {},
fields: { }
},
relNodes: [
{
relType: {
serviceTag: 'xxxx',
relationshipTag: 'rel'
},
relationshipProperties: { },
objTypes: [
{
serviceTag: 'xxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: {},
fields: {
// field
}
},
versionDataSystemFields: {
'0VersionDataLabel': {
originTimestamp:
forMatchedId:
versionedDataId:
}
}
}
]
}
},
requestParam : {
// return example send param
},
errorsFound: [],
graphServiceTag: "GraphHandler"
}

</syntaxhighlight>

== ChangeRelationshipType ==
=== Request Parameters ===
* firstObject
** Type : object
** Required : true
* secondObject
** Type : object
** Required : true
* objType
** Type : object
** Required : true
* Identifiers
** Type : object
** Required : true
* oldRelTypeAndDirection
** Type : object
** Required : true
* oldRelTypeAndDirection.relType
** Type : object
** Required : true
* oldRelTypeAndDirection.relationshipDirection
** Type : string
** Required : true
* oldRelTypeAndDirection.relationshipProperties
** Type : object
** Required : optional
* newRelType
** Type : object
** Required : true
* originTimestamp
** Type : number
** Required : true
* changedByUserId
** Type : String
** Required : true
* callingFlow
** Type : String
** Required : optional
* settings
** Type : object
** Required : optional
** Description : default > settings.changeMultipleRelationships : false // if send settings.changeMultipleRelationships : true >> can change multiple relType

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"secondObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"oldRelTypeAndDirection":{
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"old"
},
"relationshipDirection":"from",
"relationshipProperties":{
//Properties
}
},
"newRelType":{
"serviceTag":"xxxx",
"relationshipTag":"new"
},
"originTimestamp":1234567890,
"changedByUserId":"xxxx",
"callingFlow":"yyyy",
"settings":{
"changeMultipleRelationships": boolean: // default false
}
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.newRelationshipType
** Type: object
* newRelationshipType.relType
** Type: object
* newRelationshipType.relationshipDirection
** Type: string
* newRelationshipType.relationshipProperties
** Type: object
* queryResult.oldRelationshipType
** Type: object
* oldRelationshipType.relType
** Type: object
* oldRelationshipType.relationshipDirection
** Type: string
* oldRelationshipType.relationshipProperties
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
newRelationshipType: {
relType: {
serviceTag: "xxxx",
relationshipTag: "new"
},
relationshipDirection: "" // 'from' or 'to'
relationshipProperties: {}
},
oldRelationshipType: {
relType: {
serviceTag: "xxxx",
relationshipTag: "old"
},
relationshipDirection: "" // 'from' or 'to'
relationshipProperties: {}
}
},
requestParams : {
// return example send param
}
},
status: "complete" // or error,
errorsFound: [],
graphServiceTag : 'GraphHandeler'
}

</syntaxhighlight>

== DeleteRelationship ==
=== Request Parameters ===
* fromObject
** Type : object
** Required : optional
* secondObject
** Type : object
** Required : optional
* objType
** Type : object
** Required : true
* Identifiers
** Type : object
** Required : true
* relType
** Type : object
** Required : true
* relId
** Type: string
** Required : true
* relationshipDirection
** Type: string
** Required : optional
* callingFlow
** Type: string
** Required : true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"yyyy"
},
"relId":"string"
},
"relationshipDirection":"string"// "from" or "to"
"callingFlow":"string"
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.objects
** Type: array
* queryResult.objTypes
** Type: array
* queryResult.objInstanceFull.identifiers
** Type: object
* queryResult.objInstanceFull.fields
** Type: object
** Description: return data of fromObject and secondObject
* queryResult.userNode
** Type: object
** Description: return data of userNode
* queryResult.resultDeleteRel
** Type : string
** Description: return status Relationship Delete
* requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objects: [
{
objTypes: [
{
serviceTag: "xxxx",
objectType: "yyyy"
}
],
objInstanceFull: {
identifiers: {
// identifiers
},
fields: {
// fields
}
}
},
{
// if have multiple object objTypes
}
],
userNode: {
objTypes: [
{
serviceTag: "UserAccount",
objectType: "user"
}
],
objInstanceFull: {
identifiers: {
userId: "zzz"
}
}
},
resultDeleteRel: "Relationship Deleted" // default
},
requeatParam: {
// return example send param
},
status: "string", //default "complete" or "error"
errorsFound: []
}
}

</syntaxhighlight>

== DeleteNode ==
=== Request Parameters ===
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* identifiers
** Type : object
** Required: true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":"xxx",
"objectType":"yyy"
},
"identifiers":{
//
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResults
** Type: object
* queryResults.resultDeleteNode
** Type: Boolean
** Description: return status deleted node >> true or false
* requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
** Description: return status deleted node >> complete or error
* errorsFound
** Type: array
* graphServiceTag
** Type: string
=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: { resultDeleteNode: true }, // true or false
requestParams: {
// return example send param
}
},
status: 'string', // 'complete' or 'error'
errorsFound: [],
graphServiceTag: 'GraphHandler'
}
</syntaxhighlight>

== MoveRelationship ==

=== Request Parameters ===
* sourceObject
** Type : object
** Required : true
** Description: required objType: {serviceTag , objectType} and identifiers
* targetObjType
** Type : object
** Required : true
** Description: required objType: {serviceTag , objectType}
* relType
** Type : object
** Required : true
** Description: required objType: {serviceTag , relationshipTag}
* relationshipDirection
** Type : object
** Required : true
* moveToIdentifiers
** Type : object
** Required : true
* moveByUserId
** Type : String
** Required : true
* originTimestamp
** Type : number
** Required : true
* settings
** Type : object
** Required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"sourceObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyy"
},
"identifiers":{
// identifiers
}
},
"targetObjType":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
}
},
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"rel"
},
"relationshipDirection":"from", // "to"
"moveToIdentifiers":{
// target identifiers
},
"moveByUserId":"xxxx",
"originTimestamp":1234567890,
"settings":{}
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.moveRelationship
** Type: object
* moveRelationship.sourceObject
** Type: object
** Description: return data of sourceObject
* moveRelationship.relationship
** Type: string
** Description: return data of after move relationship
* moveRelationship.moveToObject
** Type: object
** Description: return data of moveToObject
* moveRelationship.historyData
** Type: object
** Description: return properties {old target identifiers and originTimestamp} after moveRelationship
* moveRelationship.userNode
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
moveRelationship: {
sourceObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
}
},
relationship: {
relType: {
serviceTag: 'xxxx',
relationshipTag: 'rel'
},
relationshipProperties: { originTimestamp: 1234567890 }
},
moveToObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: { }
},
historyData: {
relationshipProperties: { }
},
userNode: {
objTypes: [{ serviceTag: 'UserAccount', objectType: 'user' }],
objInstanceFull: { }
}
}
},
requestParam: {
}
}
status: "complete" // or error,
errorsFound: [],
graphServiceTag: 'GraphHandler'
}

</syntaxhighlight>

== MoveNodeProperties ==
=== Request Parameters ===
* sourceObject
** type: object
** required : true
* targetIdentifiers
** type : object
** required : true
* moveProperties
** type : array
** required : true // index minimum = 1
* updateProperties
** type : object
** required : true
* movePropertiesConditions
** type : array
** required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
sourceObject: {
objType: { },
identifier: { }
},
targetIdentifiers: { },
moveProperties: [ ],
updateProperties: { },
movePropertiesConditions: [ // optional
{
checkObject: 'target', // "source" | "target"
onSetObject: 'target', // "source" | "target"
onPassValue: true,
onNotPassCondition: false, // optional
fieldNameConditions: [ ]
}
]
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.moveNodeProperties
** Type: object
* moveNodeProperties.sourceObject
** Type: object
** Description: return data of sourceObject
* moveRelationship.moveFieldToObject
** Type: string
** Description: return data after moveFieldToObject
* moveRelationship.movedFields
** Type: object
** Description: return data field of moveToObject
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String
=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
moveNodeProperties: {
sourceObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: {
identifiers: { },
fields: { }
}
},
moveFieldToObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: { },
fields: {

}
},
movedFields: { Fields: { } } //
}
}
},
requestParam: { },
status: 'complete',
errorsFound: [],
graphServiceTag: 'GraphHandler'
}
</syntaxhighlight>
[[Category:Working documents| 2025-03-06]]

2025-03-06 - Graph Handler Docs

2026-06-03T05:22:40Z

Seagame: /* Request Example */

= GraphHandler Function =
== CreateNode ==
'''Use Case of CreateNode''' >>> https://izara.io/wiki/index.php/2025-03-27_Graph_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
* setFieldConditionals
** type : array
** Required : optional
* deepPathConditional
** type : array
** Required : optional
* parentFlowId
** type : string
** Required: true
* callingFlowConfig
** Type: object
** Required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType": {
"objectType": string,
"serviceTag": string
},
"objInstanceFull": {
"identifiers": {
// ...identifier
},
"fields": {
// ...fields
}
},
setFieldConditionals: [ // optional default array
{
objType: { },
indexValue: { nameSpace: 'ex-011', systemTextTag: 'Gate-011' }, // index field : value
fieldName: '', // fieldName want to set
passValue: 'false', optional
notPassValue: 'true', //optional
conditionals: [ optional ] // condition check field
}
],
"relationships": [
{
"relType": {
"serviceTag": string,
"relationshipTag": string
},
"relationshipProperties": {
//... key and value of targetIdentifiers
},
"relationshipDirection": string, // "from" | "to"
"targetObjType": {
"serviceTag": string,
"objectType": string
},
"targetIdentifiers": {
//... targetIdentifiers
}
}
],
deepPathConditional: [ // optional default array
{
condition: 'notExist', //
conditionCheck: { // traversal
nodeStructure: {
objType: { },
fields: { }
},
nextPath: {
relationshipStructure: {
relType: { },
relationshipDirection: 'to'
},
nodeStructure: {
objType: { },
fields: { }
}
}
}
}
],
"originTimestamp": number, // timestamp when create
"settings": {
"updatePropertiesOnMatch": boolean // default=false
},
"parentFlowId": "", // required
"callingFlow": string,
"callingFlowProperties": object,
}
</syntaxhighlight>

=== 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.relationships
** Type: array
** Description: data from relationships in targetNode
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* Status
** Type: string
** Description: Status from create node. Return "error" or "complete".
* errorsFound
** Type: array
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">

{
returnValue: {
queryResult: {
returnCreateNode: {
objTypes: [
{
serviceTag: "string",
objectType: "string"
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//...fields
}
},
existsNode: { },
userNode: { // // if has userNode send to createNode
objTypes: [
{
"serviceTag": "UserAccount",
"objectType": "user"
}
],
properties: {
//...properties
}
},
relationships: [ // optional : if has requiredOnCreated , createNode with targetNode
{
objTypes: [
{ serviceTag: 'string', objectType: 'string' }
],
objInstanceFull: {
identifiers: {
// identifiers
}
},
relType: {
serviceTag: 'string',
relationshipTag: 'rel'
},
relationshipProperties: {
// properties
}
},
]
}
},
requestParams: {
// return example send param
},
parentFlowId:""
},
status: "string", // "complete' or "error"
errorsFound: [],
graphServiceTag: "GraphHandler"
}

</syntaxhighlight>

== GetNode ==
'''Use Case of GetNode''' >>> https://izara.io/wiki/index.php/2025-04-23_Graph_Use_Case/GetNode_and_GetNodes#Use_Case_GetNodes
=== 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
* versionedDataLabels
** Type: Array
** Required : optional
* settings.updatePropertiesOnMatch
** Type: Boolean
** Required : optional
* parentFlowId
** Type: string
** Required: optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":string,
"objectType":string
},
"objInstanceFull":{
"identifiers":{
// ...identifier
},
"fields":{
// ...fields
}
},
"versionedDataLabels":[
//…versionedData
],
"settings": {
"returnSystemFieldsName" :boolean // default = true or false
},
"parentFlowId" : "" // optional
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* returnValue.queryResult
** Type: object
* queryResult.refactoredNodes
** Type: object
** Description: return object from getNode
* refactoredNodes.objTypes
** Type: array
* refactoredNodes.objInstanceFull
** Type: object
* refactoredNodes.objInstanceFull.identifiers
** Type: object
* refactoredNodes.objInstanceFull.fields
** Type: object
* refactoredNodes.versionDataSystemFields
** Type: object
* refactoredNodes.versionDataSystemFields.versionedDataLabel
** Type: object
* queryResult.requestParam
** Type: object
** Description: return example send param
* errorsFound
** Type: string
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
refactoredNodes: {
objTypes: [
{
serviceTag: "string",
objectType: "string",
}
],
objInstanceFull: {
identifiers: {
//… identifier
},
fields: {
//…fields
}
},
versionDataSystemFields: {
versionedDataLabel: {
originTimestamp: number,
forMatchedId: "string",
versionedDataId: "string"
}
}
}
},
requestParam: {
// return example send param
}
},
errorsFound: [],
graphServiceTag: ''
}
</syntaxhighlight>

== GetNodes ==
'''Use Case of GetNodes''' >>> https://izara.io/wiki/index.php/2025-04-23_Graph_Use_Case/GetNode_and_GetNodes#Use_Case_GetNodes
=== Request Parameters ===
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* fields
** Type : object
** Required: true
* versionedDataLabels
** Type: Array
** Required : optional
* settings.returnSystemFieldsName
** Type: Boolean
** Required : optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":string,
"objectType":string
},
"fields":{
//…fields with matching value
},
"versionedDataLabels":[
//…versionedDataLabels
],
"settings":{
"returnSystemFieldsName":boolean // default=false
}
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResults
** Type: object
* queryResults.getNodesReturnValues
** Type: array
* getNodesReturnValues.objTypes
** Type: array
* getNodesReturnValues.objInstanceFull
** Type: object
* getNodesReturnValues.objInstanceFull.identifiers
** Type: object
* getNodesReturnValues.objInstanceFull.fields
** Type: object
* getNodesReturnValues.versionDataSystemFields
** Type: object
* getNodesReturnValues.versionDataSystemFields.versionedDataLabel
** Type: object
* requestParams
** Type: object
* errorsFound
** Type: string
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: {
getNodesReturnValues: [
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//.. all fields-1
}
},
versionDataSystemFields: {}
},
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//...all fields-2
}
},
versionDataSystemFields: {
versionedDataLabel: {
originTimestamp: number,
forMatchedId: 'string',
versionedDataId: 'string'
}
}
}
]
},
requestParams: {
// return example send param
}
}
}
</syntaxhighlight>

== UpdateNode ==
''' Use Case of UpdateNode''' >>> https://izara.io/wiki/index.php/2025-08-03_-_Graph_Use_Case/UpdateNode
=== 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: object
** Required : true
* objInstanceFull.fields
** Type : object
** Required: true
** Description : can not send fields to update mainNode and versionedData together
* versionedDataIds
** Type: object
** Required: optional
* originTimestamp
** Type: number
** Required: true
* settings
** Type: object
** Required: optional
* callingFlow
** Type: string
** Required: optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType": {
"serviceTag": string,
"objectType": string
},
"objInstanceFull": {
"identifiers": {
//…identifiers
},
"fields": {
//…fields
// can not be send fields of mainNode and versionedData in fields together!
}
},
"versionedDataIds": {},
"originTimestamp": number, //// timestamp when update
"settings": {},
"callingFlow": string
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* returnValue.queryResult
** Type: object
** Description: data from created node
* queryResult.objTypes
** Type: array
** Description: serviceTag and objectType
* queryResult.objInstanceFull
** Type: object
** Description: identifiers and fields
* queryResult.userId
** Type: object
** Description: data that update from user Account
* queryResult.versionDataSystemFields
** Type: object
** Description: optional return versionedData
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* returnValue.Status
** Type: string
** Description: status from updated node // error or complete
* returnValue.errorsFound
** Type: array
* returnValue.graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifiers
},
fields: {
//...fields
}
},
userId: {
// if have userNode send to updated
},
versionDataSystemFields: {
versionedDataLabel: {
}
}
},
requestParams: {
// return example send param
}
},
status: 'string',//"complete" // "error"
errorsFound: [],
graphServiceTag: 'string'
}
</syntaxhighlight>

== CreateRelationship ==
''' Use Case of CreateRelationship''' >>> https://izara.io/wiki/index.php/2025-08-01_-_Graph_Use_Case/CreateRelationship
=== Request Parameters ===
* firstObject
** Type: object
** Required: true
* secondObject
** Type: object
** Required: true
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* identifiers
** Type: object
** Required : true
* createRelationshipIfNothave
** Type : array
** Required: optional
** Description : using createRelationshipIfNothave for check relationship if not has created , can check both firstNode and SeconNode or onCreateAddRelationships
* onCreateAddRelationships
** Type: array of object
** Required: optional
* relType
** Type: object
** Required: true
* relationshipDirection
** Type: string
** Required: true
* relationshipProperties
** Type: object
** Required: true
* Settings
** Type: object
** Required: true
* settings.updateRelPropsWhenExist
** Type: boolean
** Required: optional
* callingFlow
** Type: string
** Required: optional
* callingFlowConfig
** Type: object
** Required: optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject": {
"objType": {
"serviceTag": string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"createRelationshipIfNothave": [ // optional
{
"onMatchRelationship": {
"relType": {
"serviceTag": string,
"relationshipTag": string
},
"relationshipProperties": {},
"relationshipDirection": string
},
"onMatchNode": {
"objType": {
"serviceTag":string,
"objectType": string
},
"fields": {
}
}
}
],
"onCreateAddRelationships": [
{
"objType": {
"serviceTag":string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"relType": {
"serviceTag":string,
"relationshipTag":string
},
"relationshipProperties": {
//…properties
},
"relationshipDirection":string // “from” , “to”
}
]
},
"secondObject": {
"objType": {
"serviceTag":string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"onCreateAddRelationships": [
//…optional
]
},
"relType": {
"serviceTag":string,
"relationshipTag":string
},
"relationshipDirection":string, // “from” , “to”
"relationshipProperties": {
//…properties
},
"settings": {
"updateRelPropsWhenExist": boolean,
},
"callingFlow": "xxxx",
"callingFlowProperties": {
"graphServiceName": string
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.relationship
** Type: object
* queryResult.relationship.relType
** Type: object
* queryResult.relationship.relationshipProperties
** Type: object
* queryResult.firstNode
** Type: object
** Description: return data structure from firstNode
* queryResult.secondNode
** Type: object
** Description: return data structure from secondNode
* queryResult..onCreateAddRelationships
** Type: array
** Description: return data structure from onCreateAddRelationships
* returnValue.firstObject
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* Status
** Type: string
** Description: status from create node // error or complete
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
relationship: {
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//…properties
}
},
firstNode: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: { //… identifiers },
fields: {
//… all fields
}
},
onCreateAddRelationships: [
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//… identifiers
},
fields: {
//… all fields
}
},
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//… all properties
}
}
]
},
secondNode: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: { //… identifiers },
fields: {
//… all fields
}
},
onCreateAddRelationships: [
//… optional
]
}
}
}
}
requestParams: {
// return example send param

},
Status: 'string', //“complete” // “error”
errorsFound: []
}
}
</syntaxhighlight>

== GetRelationship ==
=== Request Parameters ===
* firstObject
** Type: object
** Required: optional
* secondObject
** Type: object
** Required: optional
* objType
** Type: object
** Required: true
** Description: has serviceTag and objectType
* identifiers
** Type: object
** Required: true
* relType
** Type: object
** Required: true
** Description: has relationshipTag and serviceTag
* relId
** Type: string
** Required: true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag":string,
"objectType":string
},
"identifiers":{
//…identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"relType":{ // required
"relationshipTag": string,
"serviceTag": string
},
"relId": 'string' // // required
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
* Type: object
* queryResult.relType
** Type: object
* queryResult.relationshipProperties
** Type: object
** Description: return relId and properties
* returnValue.toObject
** Type: object
** Description: return toObject if not send secondObject from param
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* errorsFound
** Type: array
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: {
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//…properties : 'string’
}
},
toObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: {
identifiers: {
//
},
fields: { }
}
},
requestParams: {
// return example send param
}
}
}

</syntaxhighlight>

== UpdateRelationship ==
=== Request Parameters ===
* firstObject
** Type: object
** Required: optional
* secondObject
** Type: object
** Required: Optional
* objType
** Type: object
** Required: true
** Description: has serviceTag and objectType
* identifiers
** Type: object
** Required: true
* relId
** Type: string
** Required: true
* relType
** Type: object
** Required: true
** Description: has relationshipTag and serviceTag
* relationshipProperties
** Type: object
** Required: true
** Description: send properties that want to update
* relationshipDirection
** Type: string
** Required: optional
* callingFlow
** Type: string
** Required: optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"relId": string,
"relType":{
"serviceTag":string,
"relationshipTag":string
},
"relationshipProperties":{
//… properties that want to update
},
"relationshipDirection": string, // "from" // “to”
"callingFlow": string
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.firstObject And secondObject
** Type: object
** Description : return objType {seviceTag and objectType} And identifiers
* queryResult.relId
** Type: string
* queryResult.relType
** Type: object
** Description: return {seviceTag and relationshipTag}
* queryResult.relationshipDirection
** Type: string
* queryResult.updatePropertiesParam
** Type: object
** Description: return properties to updated
* queryResult.oldRelationshipProperties
** Type: object
** Description: return old properties before update
* queryResult.newRelationshipProperties
** Type: object
** Description: return new properties after updated
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type : string
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
firstObject: {
objType: {
serviceTag: "string",
objectType: "string"
},
identifiers: {
//…identifiers
}
},
secondObject: {
objType: {
serviceTag: "string",
objectType: "string"
},
identifiers: {
//…identifiers
}
},
relId: "string",
relType: {
serviceTag: "string",
relationshipTag: "string"
},
relationshipDirection: "string",
updatePropertiesParam: {
//… properties updated
},
oldRelationshipProperties: {
// … old properties before update
},
newRelationshipProperties: {
//… new properties after updated
}
}
},
requestParams: {
// return example send param
}
status: “string”, // "complete",”error”
errorsFound: []
}
</syntaxhighlight>

== GetNodeAndRelationship ==
=== Request Parameters ===
* sourceObjType
** Required: true
** Description: has serviceTag and objectType
* sourceIdentifiers
** Type: object
** Required: true
* sourceVersionedDataLabels
** Type: object
** Required: optional
* targetRelationships
** Type: Array
** Required: true
* relTypeAndDirection
** Type: object
** Required: true
* relTypeAndDirection.relType
** Type: object
** Required: true
** Description: has serviceTag and relationshipTag
* relTypeAndDirection.relationshipProperties
** Type: object
** Required: optional
* relTypeAndDirection.relationshipDirection
** Type: String
** Required: optional
* targetObjects
** Type: Array
** Required: Optional
* targetObjects.objType
** Type: object
** Required: required if send targetObjects in param
* targetObjects.identifiers
** Type: object
** Required: optional should have objType if identifiers exists
* targetObjects.versionedDataLabels
** Type: object
** Required: optional have objType if versionedDataLabels exists

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"sourceObjType": { // required
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"sourceIdentifiers": {}, // required
"sourceVersionedDataLabels": [], // optional
"targetRelationships": [ //required
{
"relTypeAndDirection": { // required
"relType": {
"serviceTag": "xxxx",
"relationshipTag": "rel"
},
"relationshipProperties": {},//optional
"relationshipDirection": "" // required
},
"targetObjects": [ // optional
{
"objType": {
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"identifiers": {}, // optional
"versionedDataLabels": [] // optional have objType if versionedDataLabels exists
}
]
},
// if have multiple relTypeAndDirection
],
"settings": {} // defaulf = false >>> if have versionedDataLabels want to return all field of versionedata: settings = { returnSystemFieldsName: true }
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.objTypes
** Type: array of object
** Description: return {serviceTag and objectType}
* queryResult.objInstanceFull
** Type: object
** Description: return {identifiers and fields}
* queryResult.relNodes:
** Type: array
* relNodes.relType
** Type: object
** Description: return {serviceTag and relationshipTag}
* relNodes.relationshipProperties
** Type: object
* relNodes.objTypes
** Type: array of object
** Description: return {serviceTag and objectType}
* relNodes.objInstanceFull
** Type: object
** Description: return {identifiers and fields}
* requestParams
** Type: object
** Description: return same requestParams
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: {},
fields: { }
},
relNodes: [
{
relType: {
serviceTag: 'xxxx',
relationshipTag: 'rel'
},
relationshipProperties: { },
objTypes: [
{
serviceTag: 'xxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: {},
fields: {
// field
}
},
versionDataSystemFields: {
'0VersionDataLabel': {
originTimestamp:
forMatchedId:
versionedDataId:
}
}
}
]
}
},
requestParam : {
// return example send param
},
errorsFound: [],
graphServiceTag: "GraphHandler"
}

</syntaxhighlight>

== ChangeRelationshipType ==
=== Request Parameters ===
* firstObject
** Type : object
** Required : true
* secondObject
** Type : object
** Required : true
* objType
** Type : object
** Required : true
* Identifiers
** Type : object
** Required : true
* oldRelTypeAndDirection
** Type : object
** Required : true
* oldRelTypeAndDirection.relType
** Type : object
** Required : true
* oldRelTypeAndDirection.relationshipDirection
** Type : string
** Required : true
* oldRelTypeAndDirection.relationshipProperties
** Type : object
** Required : optional
* newRelType
** Type : object
** Required : true
* originTimestamp
** Type : number
** Required : true
* changedByUserId
** Type : String
** Required : true
* callingFlow
** Type : String
** Required : optional
* settings
** Type : object
** Required : optional
** Description : default > settings.changeMultipleRelationships : false // if send settings.changeMultipleRelationships : true >> can change multiple relType

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"secondObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"oldRelTypeAndDirection":{
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"old"
},
"relationshipDirection":"from",
"relationshipProperties":{
//Properties
}
},
"newRelType":{
"serviceTag":"xxxx",
"relationshipTag":"new"
},
"originTimestamp":1234567890,
"changedByUserId":"xxxx",
"callingFlow":"yyyy",
"settings":{
"changeMultipleRelationships": boolean: // default false
}
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.newRelationshipType
** Type: object
* newRelationshipType.relType
** Type: object
* newRelationshipType.relationshipDirection
** Type: string
* newRelationshipType.relationshipProperties
** Type: object
* queryResult.oldRelationshipType
** Type: object
* oldRelationshipType.relType
** Type: object
* oldRelationshipType.relationshipDirection
** Type: string
* oldRelationshipType.relationshipProperties
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
newRelationshipType: {
relType: {
serviceTag: "xxxx",
relationshipTag: "new"
},
relationshipDirection: "" // 'from' or 'to'
relationshipProperties: {}
},
oldRelationshipType: {
relType: {
serviceTag: "xxxx",
relationshipTag: "old"
},
relationshipDirection: "" // 'from' or 'to'
relationshipProperties: {}
}
},
requestParams : {
// return example send param
}
},
status: "complete" // or error,
errorsFound: [],
graphServiceTag : 'GraphHandeler'
}

</syntaxhighlight>

== DeleteRelationship ==
=== Request Parameters ===
* fromObject
** Type : object
** Required : optional
* secondObject
** Type : object
** Required : optional
* objType
** Type : object
** Required : true
* Identifiers
** Type : object
** Required : true
* relType
** Type : object
** Required : true
* relId
** Type: string
** Required : true
* relationshipDirection
** Type: string
** Required : optional
* callingFlow
** Type: string
** Required : true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"yyyy"
},
"relId":"string"
},
"relationshipDirection":"string"// "from" or "to"
"callingFlow":"string"
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.objects
** Type: array
* queryResult.objTypes
** Type: array
* queryResult.objInstanceFull.identifiers
** Type: object
* queryResult.objInstanceFull.fields
** Type: object
** Description: return data of fromObject and secondObject
* queryResult.userNode
** Type: object
** Description: return data of userNode
* queryResult.resultDeleteRel
** Type : string
** Description: return status Relationship Delete
* requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objects: [
{
objTypes: [
{
serviceTag: "xxxx",
objectType: "yyyy"
}
],
objInstanceFull: {
identifiers: {
// identifiers
},
fields: {
// fields
}
}
},
{
// if have multiple object objTypes
}
],
userNode: {
objTypes: [
{
serviceTag: "UserAccount",
objectType: "user"
}
],
objInstanceFull: {
identifiers: {
userId: "zzz"
}
}
},
resultDeleteRel: "Relationship Deleted" // default
},
requeatParam: {
// return example send param
},
status: "string", //default "complete" or "error"
errorsFound: []
}
}

</syntaxhighlight>

== DeleteNode ==
=== Request Parameters ===
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* identifiers
** Type : object
** Required: true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":"xxx",
"objectType":"yyy"
},
"identifiers":{
//
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResults
** Type: object
* queryResults.resultDeleteNode
** Type: Boolean
** Description: return status deleted node >> true or false
* requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
** Description: return status deleted node >> complete or error
* errorsFound
** Type: array
* graphServiceTag
** Type: string
=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: { resultDeleteNode: true }, // true or false
requestParams: {
// return example send param
}
},
status: 'string', // 'complete' or 'error'
errorsFound: [],
graphServiceTag: 'GraphHandler'
}
</syntaxhighlight>

== MoveRelationship ==

=== Request Parameters ===
* sourceObject
** Type : object
** Required : true
** Description: required objType: {serviceTag , objectType} and identifiers
* targetObjType
** Type : object
** Required : true
** Description: required objType: {serviceTag , objectType}
* relType
** Type : object
** Required : true
** Description: required objType: {serviceTag , relationshipTag}
* relationshipDirection
** Type : object
** Required : true
* moveToIdentifiers
** Type : object
** Required : true
* moveByUserId
** Type : String
** Required : true
* originTimestamp
** Type : number
** Required : true
* settings
** Type : object
** Required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"sourceObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyy"
},
"identifiers":{
// identifiers
}
},
"targetObjType":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
}
},
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"rel"
},
"relationshipDirection":"from", // "to"
"moveToIdentifiers":{
// target identifiers
},
"moveByUserId":"xxxx",
"originTimestamp":1234567890,
"settings":{}
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.moveRelationship
** Type: object
* moveRelationship.sourceObject
** Type: object
** Description: return data of sourceObject
* moveRelationship.relationship
** Type: string
** Description: return data of after move relationship
* moveRelationship.moveToObject
** Type: object
** Description: return data of moveToObject
* moveRelationship.historyData
** Type: object
** Description: return properties {old target identifiers and originTimestamp} after moveRelationship
* moveRelationship.userNode
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
moveRelationship: {
sourceObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
}
},
relationship: {
relType: {
serviceTag: 'xxxx',
relationshipTag: 'rel'
},
relationshipProperties: { originTimestamp: 1234567890 }
},
moveToObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: { }
},
historyData: {
relationshipProperties: { }
},
userNode: {
objTypes: [{ serviceTag: 'UserAccount', objectType: 'user' }],
objInstanceFull: { }
}
}
},
requestParam: {
}
}
status: "complete" // or error,
errorsFound: [],
graphServiceTag: 'GraphHandler'
}

</syntaxhighlight>

== MoveNodeProperties ==
=== Request Parameters ===
* sourceObject
** type: object
** required : true
* targetIdentifiers
** type : object
** required : true
* moveProperties
** type : array
** required : true // index minimum = 1
* updateProperties
** type : object
** required : true
* movePropertiesConditions
** type : array
** required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
sourceObject: {
objType: { },
identifier: { }
},
targetIdentifiers: { },
moveProperties: [ ],
updateProperties: { },
movePropertiesConditions: [ // optional
{
checkObject: 'target', // "source" | "target"
onSetObject: 'target', // "source" | "target"
onPassValue: true,
onNotPassCondition: false, // optional
fieldNameConditions: [ ]
}
]
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.moveNodeProperties
** Type: object
* moveNodeProperties.sourceObject
** Type: object
** Description: return data of sourceObject
* moveRelationship.moveFieldToObject
** Type: string
** Description: return data after moveFieldToObject
* moveRelationship.movedFields
** Type: object
** Description: return data field of moveToObject
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String
=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
moveNodeProperties: {
sourceObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: {
identifiers: { },
fields: { }
}
},
moveFieldToObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: { },
fields: {

}
},
movedFields: { Fields: { } } //
}
}
},
requestParam: { },
status: 'complete',
errorsFound: [],
graphServiceTag: 'GraphHandler'
}
</syntaxhighlight>
[[Category:Working documents| 2025-03-06]]

2025-03-06 - Graph Handler Docs

2026-06-03T05:22:16Z

Seagame: /* Request Example */

= GraphHandler Function =
== CreateNode ==
'''Use Case of CreateNode''' >>> https://izara.io/wiki/index.php/2025-03-27_Graph_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
* setFieldConditionals
** type : array
** Required : optional
* deepPathConditional
** type : array
** Required : optional
* parentFlowId
** type : string
** Required: true
* callingFlowConfig
** Type: object
** Required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType": {
"objectType": string,
"serviceTag": string
},
"objInstanceFull": {
"identifiers": {
// ...identifier
},
"fields": {
// ...fields
}
},
setFieldConditionals: [ // optional default array
{
objType: { },
indexValue: { nameSpace: 'ex-011', systemTextTag: 'Gate-011' }, // index field : value
fieldName: '', // fieldName want to set
passValue: 'false', optional
notPassValue: 'true', //optional
conditionals: [ optional ] // condition check field
}
],
"relationships": [
{
"relType": {
"serviceTag": string,
"relationshipTag": string
},
"relationshipProperties": {
//... key and value of targetIdentifiers
},
"relationshipDirection": string, // "from" | "to"
"targetObjType": {
"serviceTag": string,
"objectType": string
},
"targetIdentifiers": {
//... targetIdentifiers
}
}
],
deepPathConditional: [ // optional default array
{
condition: 'notExist', //
conditionCheck: { // traversal
nodeStructure: {
objType: { },
fields: { }
},
nextPath: {
relationshipStructure: {
relType: { },
relationshipDirection: 'to'
},
nodeStructure: {
objType: { },
fields: { }
}
}
}
}
],
"originTimestamp": number, // timestamp when create
"settings": {
"updatePropertiesOnMatch": boolean // default=false
},
"parentFlowId": "",
"callingFlow": string,
"callingFlowProperties": object,
}
</syntaxhighlight>

=== 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.relationships
** Type: array
** Description: data from relationships in targetNode
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* Status
** Type: string
** Description: Status from create node. Return "error" or "complete".
* errorsFound
** Type: array
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">

{
returnValue: {
queryResult: {
returnCreateNode: {
objTypes: [
{
serviceTag: "string",
objectType: "string"
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//...fields
}
},
existsNode: { },
userNode: { // // if has userNode send to createNode
objTypes: [
{
"serviceTag": "UserAccount",
"objectType": "user"
}
],
properties: {
//...properties
}
},
relationships: [ // optional : if has requiredOnCreated , createNode with targetNode
{
objTypes: [
{ serviceTag: 'string', objectType: 'string' }
],
objInstanceFull: {
identifiers: {
// identifiers
}
},
relType: {
serviceTag: 'string',
relationshipTag: 'rel'
},
relationshipProperties: {
// properties
}
},
]
}
},
requestParams: {
// return example send param
},
parentFlowId:""
},
status: "string", // "complete' or "error"
errorsFound: [],
graphServiceTag: "GraphHandler"
}

</syntaxhighlight>

== GetNode ==
'''Use Case of GetNode''' >>> https://izara.io/wiki/index.php/2025-04-23_Graph_Use_Case/GetNode_and_GetNodes#Use_Case_GetNodes
=== 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
* versionedDataLabels
** Type: Array
** Required : optional
* settings.updatePropertiesOnMatch
** Type: Boolean
** Required : optional
* parentFlowId
** Type: string
** Required: optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":string,
"objectType":string
},
"objInstanceFull":{
"identifiers":{
// ...identifier
},
"fields":{
// ...fields
}
},
"versionedDataLabels":[
//…versionedData
],
"settings": {
"returnSystemFieldsName" :boolean // default = true or false
},
"parentFlowId" : "" // optional
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* returnValue.queryResult
** Type: object
* queryResult.refactoredNodes
** Type: object
** Description: return object from getNode
* refactoredNodes.objTypes
** Type: array
* refactoredNodes.objInstanceFull
** Type: object
* refactoredNodes.objInstanceFull.identifiers
** Type: object
* refactoredNodes.objInstanceFull.fields
** Type: object
* refactoredNodes.versionDataSystemFields
** Type: object
* refactoredNodes.versionDataSystemFields.versionedDataLabel
** Type: object
* queryResult.requestParam
** Type: object
** Description: return example send param
* errorsFound
** Type: string
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
refactoredNodes: {
objTypes: [
{
serviceTag: "string",
objectType: "string",
}
],
objInstanceFull: {
identifiers: {
//… identifier
},
fields: {
//…fields
}
},
versionDataSystemFields: {
versionedDataLabel: {
originTimestamp: number,
forMatchedId: "string",
versionedDataId: "string"
}
}
}
},
requestParam: {
// return example send param
}
},
errorsFound: [],
graphServiceTag: ''
}
</syntaxhighlight>

== GetNodes ==
'''Use Case of GetNodes''' >>> https://izara.io/wiki/index.php/2025-04-23_Graph_Use_Case/GetNode_and_GetNodes#Use_Case_GetNodes
=== Request Parameters ===
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* fields
** Type : object
** Required: true
* versionedDataLabels
** Type: Array
** Required : optional
* settings.returnSystemFieldsName
** Type: Boolean
** Required : optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":string,
"objectType":string
},
"fields":{
//…fields with matching value
},
"versionedDataLabels":[
//…versionedDataLabels
],
"settings":{
"returnSystemFieldsName":boolean // default=false
}
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResults
** Type: object
* queryResults.getNodesReturnValues
** Type: array
* getNodesReturnValues.objTypes
** Type: array
* getNodesReturnValues.objInstanceFull
** Type: object
* getNodesReturnValues.objInstanceFull.identifiers
** Type: object
* getNodesReturnValues.objInstanceFull.fields
** Type: object
* getNodesReturnValues.versionDataSystemFields
** Type: object
* getNodesReturnValues.versionDataSystemFields.versionedDataLabel
** Type: object
* requestParams
** Type: object
* errorsFound
** Type: string
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: {
getNodesReturnValues: [
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//.. all fields-1
}
},
versionDataSystemFields: {}
},
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//...all fields-2
}
},
versionDataSystemFields: {
versionedDataLabel: {
originTimestamp: number,
forMatchedId: 'string',
versionedDataId: 'string'
}
}
}
]
},
requestParams: {
// return example send param
}
}
}
</syntaxhighlight>

== UpdateNode ==
''' Use Case of UpdateNode''' >>> https://izara.io/wiki/index.php/2025-08-03_-_Graph_Use_Case/UpdateNode
=== 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: object
** Required : true
* objInstanceFull.fields
** Type : object
** Required: true
** Description : can not send fields to update mainNode and versionedData together
* versionedDataIds
** Type: object
** Required: optional
* originTimestamp
** Type: number
** Required: true
* settings
** Type: object
** Required: optional
* callingFlow
** Type: string
** Required: optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType": {
"serviceTag": string,
"objectType": string
},
"objInstanceFull": {
"identifiers": {
//…identifiers
},
"fields": {
//…fields
// can not be send fields of mainNode and versionedData in fields together!
}
},
"versionedDataIds": {},
"originTimestamp": number, //// timestamp when update
"settings": {},
"callingFlow": string
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* returnValue.queryResult
** Type: object
** Description: data from created node
* queryResult.objTypes
** Type: array
** Description: serviceTag and objectType
* queryResult.objInstanceFull
** Type: object
** Description: identifiers and fields
* queryResult.userId
** Type: object
** Description: data that update from user Account
* queryResult.versionDataSystemFields
** Type: object
** Description: optional return versionedData
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* returnValue.Status
** Type: string
** Description: status from updated node // error or complete
* returnValue.errorsFound
** Type: array
* returnValue.graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifiers
},
fields: {
//...fields
}
},
userId: {
// if have userNode send to updated
},
versionDataSystemFields: {
versionedDataLabel: {
}
}
},
requestParams: {
// return example send param
}
},
status: 'string',//"complete" // "error"
errorsFound: [],
graphServiceTag: 'string'
}
</syntaxhighlight>

== CreateRelationship ==
''' Use Case of CreateRelationship''' >>> https://izara.io/wiki/index.php/2025-08-01_-_Graph_Use_Case/CreateRelationship
=== Request Parameters ===
* firstObject
** Type: object
** Required: true
* secondObject
** Type: object
** Required: true
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* identifiers
** Type: object
** Required : true
* createRelationshipIfNothave
** Type : array
** Required: optional
** Description : using createRelationshipIfNothave for check relationship if not has created , can check both firstNode and SeconNode or onCreateAddRelationships
* onCreateAddRelationships
** Type: array of object
** Required: optional
* relType
** Type: object
** Required: true
* relationshipDirection
** Type: string
** Required: true
* relationshipProperties
** Type: object
** Required: true
* Settings
** Type: object
** Required: true
* settings.updateRelPropsWhenExist
** Type: boolean
** Required: optional
* callingFlow
** Type: string
** Required: optional
* callingFlowConfig
** Type: object
** Required: optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject": {
"objType": {
"serviceTag": string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"createRelationshipIfNothave": [ // optional
{
"onMatchRelationship": {
"relType": {
"serviceTag": string,
"relationshipTag": string
},
"relationshipProperties": {},
"relationshipDirection": string
},
"onMatchNode": {
"objType": {
"serviceTag":string,
"objectType": string
},
"fields": {
}
}
}
],
"onCreateAddRelationships": [
{
"objType": {
"serviceTag":string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"relType": {
"serviceTag":string,
"relationshipTag":string
},
"relationshipProperties": {
//…properties
},
"relationshipDirection":string // “from” , “to”
}
]
},
"secondObject": {
"objType": {
"serviceTag":string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"onCreateAddRelationships": [
//…optional
]
},
"relType": {
"serviceTag":string,
"relationshipTag":string
},
"relationshipDirection":string, // “from” , “to”
"relationshipProperties": {
//…properties
},
"settings": {
"updateRelPropsWhenExist": boolean,
},
"callingFlow": "xxxx",
"callingFlowProperties": {
"graphServiceName": string
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.relationship
** Type: object
* queryResult.relationship.relType
** Type: object
* queryResult.relationship.relationshipProperties
** Type: object
* queryResult.firstNode
** Type: object
** Description: return data structure from firstNode
* queryResult.secondNode
** Type: object
** Description: return data structure from secondNode
* queryResult..onCreateAddRelationships
** Type: array
** Description: return data structure from onCreateAddRelationships
* returnValue.firstObject
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* Status
** Type: string
** Description: status from create node // error or complete
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
relationship: {
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//…properties
}
},
firstNode: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: { //… identifiers },
fields: {
//… all fields
}
},
onCreateAddRelationships: [
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//… identifiers
},
fields: {
//… all fields
}
},
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//… all properties
}
}
]
},
secondNode: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: { //… identifiers },
fields: {
//… all fields
}
},
onCreateAddRelationships: [
//… optional
]
}
}
}
}
requestParams: {
// return example send param

},
Status: 'string', //“complete” // “error”
errorsFound: []
}
}
</syntaxhighlight>

== GetRelationship ==
=== Request Parameters ===
* firstObject
** Type: object
** Required: optional
* secondObject
** Type: object
** Required: optional
* objType
** Type: object
** Required: true
** Description: has serviceTag and objectType
* identifiers
** Type: object
** Required: true
* relType
** Type: object
** Required: true
** Description: has relationshipTag and serviceTag
* relId
** Type: string
** Required: true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag":string,
"objectType":string
},
"identifiers":{
//…identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"relType":{ // required
"relationshipTag": string,
"serviceTag": string
},
"relId": 'string' // // required
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
* Type: object
* queryResult.relType
** Type: object
* queryResult.relationshipProperties
** Type: object
** Description: return relId and properties
* returnValue.toObject
** Type: object
** Description: return toObject if not send secondObject from param
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* errorsFound
** Type: array
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: {
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//…properties : 'string’
}
},
toObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: {
identifiers: {
//
},
fields: { }
}
},
requestParams: {
// return example send param
}
}
}

</syntaxhighlight>

== UpdateRelationship ==
=== Request Parameters ===
* firstObject
** Type: object
** Required: optional
* secondObject
** Type: object
** Required: Optional
* objType
** Type: object
** Required: true
** Description: has serviceTag and objectType
* identifiers
** Type: object
** Required: true
* relId
** Type: string
** Required: true
* relType
** Type: object
** Required: true
** Description: has relationshipTag and serviceTag
* relationshipProperties
** Type: object
** Required: true
** Description: send properties that want to update
* relationshipDirection
** Type: string
** Required: optional
* callingFlow
** Type: string
** Required: optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"relId": string,
"relType":{
"serviceTag":string,
"relationshipTag":string
},
"relationshipProperties":{
//… properties that want to update
},
"relationshipDirection": string, // "from" // “to”
"callingFlow": string
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.firstObject And secondObject
** Type: object
** Description : return objType {seviceTag and objectType} And identifiers
* queryResult.relId
** Type: string
* queryResult.relType
** Type: object
** Description: return {seviceTag and relationshipTag}
* queryResult.relationshipDirection
** Type: string
* queryResult.updatePropertiesParam
** Type: object
** Description: return properties to updated
* queryResult.oldRelationshipProperties
** Type: object
** Description: return old properties before update
* queryResult.newRelationshipProperties
** Type: object
** Description: return new properties after updated
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type : string
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
firstObject: {
objType: {
serviceTag: "string",
objectType: "string"
},
identifiers: {
//…identifiers
}
},
secondObject: {
objType: {
serviceTag: "string",
objectType: "string"
},
identifiers: {
//…identifiers
}
},
relId: "string",
relType: {
serviceTag: "string",
relationshipTag: "string"
},
relationshipDirection: "string",
updatePropertiesParam: {
//… properties updated
},
oldRelationshipProperties: {
// … old properties before update
},
newRelationshipProperties: {
//… new properties after updated
}
}
},
requestParams: {
// return example send param
}
status: “string”, // "complete",”error”
errorsFound: []
}
</syntaxhighlight>

== GetNodeAndRelationship ==
=== Request Parameters ===
* sourceObjType
** Required: true
** Description: has serviceTag and objectType
* sourceIdentifiers
** Type: object
** Required: true
* sourceVersionedDataLabels
** Type: object
** Required: optional
* targetRelationships
** Type: Array
** Required: true
* relTypeAndDirection
** Type: object
** Required: true
* relTypeAndDirection.relType
** Type: object
** Required: true
** Description: has serviceTag and relationshipTag
* relTypeAndDirection.relationshipProperties
** Type: object
** Required: optional
* relTypeAndDirection.relationshipDirection
** Type: String
** Required: optional
* targetObjects
** Type: Array
** Required: Optional
* targetObjects.objType
** Type: object
** Required: required if send targetObjects in param
* targetObjects.identifiers
** Type: object
** Required: optional should have objType if identifiers exists
* targetObjects.versionedDataLabels
** Type: object
** Required: optional have objType if versionedDataLabels exists

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"sourceObjType": { // required
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"sourceIdentifiers": {}, // required
"sourceVersionedDataLabels": [], // optional
"targetRelationships": [ //required
{
"relTypeAndDirection": { // required
"relType": {
"serviceTag": "xxxx",
"relationshipTag": "rel"
},
"relationshipProperties": {},//optional
"relationshipDirection": "" // required
},
"targetObjects": [ // optional
{
"objType": {
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"identifiers": {}, // optional
"versionedDataLabels": [] // optional have objType if versionedDataLabels exists
}
]
},
// if have multiple relTypeAndDirection
],
"settings": {} // defaulf = false >>> if have versionedDataLabels want to return all field of versionedata: settings = { returnSystemFieldsName: true }
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.objTypes
** Type: array of object
** Description: return {serviceTag and objectType}
* queryResult.objInstanceFull
** Type: object
** Description: return {identifiers and fields}
* queryResult.relNodes:
** Type: array
* relNodes.relType
** Type: object
** Description: return {serviceTag and relationshipTag}
* relNodes.relationshipProperties
** Type: object
* relNodes.objTypes
** Type: array of object
** Description: return {serviceTag and objectType}
* relNodes.objInstanceFull
** Type: object
** Description: return {identifiers and fields}
* requestParams
** Type: object
** Description: return same requestParams
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: {},
fields: { }
},
relNodes: [
{
relType: {
serviceTag: 'xxxx',
relationshipTag: 'rel'
},
relationshipProperties: { },
objTypes: [
{
serviceTag: 'xxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: {},
fields: {
// field
}
},
versionDataSystemFields: {
'0VersionDataLabel': {
originTimestamp:
forMatchedId:
versionedDataId:
}
}
}
]
}
},
requestParam : {
// return example send param
},
errorsFound: [],
graphServiceTag: "GraphHandler"
}

</syntaxhighlight>

== ChangeRelationshipType ==
=== Request Parameters ===
* firstObject
** Type : object
** Required : true
* secondObject
** Type : object
** Required : true
* objType
** Type : object
** Required : true
* Identifiers
** Type : object
** Required : true
* oldRelTypeAndDirection
** Type : object
** Required : true
* oldRelTypeAndDirection.relType
** Type : object
** Required : true
* oldRelTypeAndDirection.relationshipDirection
** Type : string
** Required : true
* oldRelTypeAndDirection.relationshipProperties
** Type : object
** Required : optional
* newRelType
** Type : object
** Required : true
* originTimestamp
** Type : number
** Required : true
* changedByUserId
** Type : String
** Required : true
* callingFlow
** Type : String
** Required : optional
* settings
** Type : object
** Required : optional
** Description : default > settings.changeMultipleRelationships : false // if send settings.changeMultipleRelationships : true >> can change multiple relType

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"secondObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"oldRelTypeAndDirection":{
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"old"
},
"relationshipDirection":"from",
"relationshipProperties":{
//Properties
}
},
"newRelType":{
"serviceTag":"xxxx",
"relationshipTag":"new"
},
"originTimestamp":1234567890,
"changedByUserId":"xxxx",
"callingFlow":"yyyy",
"settings":{
"changeMultipleRelationships": boolean: // default false
}
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.newRelationshipType
** Type: object
* newRelationshipType.relType
** Type: object
* newRelationshipType.relationshipDirection
** Type: string
* newRelationshipType.relationshipProperties
** Type: object
* queryResult.oldRelationshipType
** Type: object
* oldRelationshipType.relType
** Type: object
* oldRelationshipType.relationshipDirection
** Type: string
* oldRelationshipType.relationshipProperties
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
newRelationshipType: {
relType: {
serviceTag: "xxxx",
relationshipTag: "new"
},
relationshipDirection: "" // 'from' or 'to'
relationshipProperties: {}
},
oldRelationshipType: {
relType: {
serviceTag: "xxxx",
relationshipTag: "old"
},
relationshipDirection: "" // 'from' or 'to'
relationshipProperties: {}
}
},
requestParams : {
// return example send param
}
},
status: "complete" // or error,
errorsFound: [],
graphServiceTag : 'GraphHandeler'
}

</syntaxhighlight>

== DeleteRelationship ==
=== Request Parameters ===
* fromObject
** Type : object
** Required : optional
* secondObject
** Type : object
** Required : optional
* objType
** Type : object
** Required : true
* Identifiers
** Type : object
** Required : true
* relType
** Type : object
** Required : true
* relId
** Type: string
** Required : true
* relationshipDirection
** Type: string
** Required : optional
* callingFlow
** Type: string
** Required : true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"yyyy"
},
"relId":"string"
},
"relationshipDirection":"string"// "from" or "to"
"callingFlow":"string"
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.objects
** Type: array
* queryResult.objTypes
** Type: array
* queryResult.objInstanceFull.identifiers
** Type: object
* queryResult.objInstanceFull.fields
** Type: object
** Description: return data of fromObject and secondObject
* queryResult.userNode
** Type: object
** Description: return data of userNode
* queryResult.resultDeleteRel
** Type : string
** Description: return status Relationship Delete
* requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objects: [
{
objTypes: [
{
serviceTag: "xxxx",
objectType: "yyyy"
}
],
objInstanceFull: {
identifiers: {
// identifiers
},
fields: {
// fields
}
}
},
{
// if have multiple object objTypes
}
],
userNode: {
objTypes: [
{
serviceTag: "UserAccount",
objectType: "user"
}
],
objInstanceFull: {
identifiers: {
userId: "zzz"
}
}
},
resultDeleteRel: "Relationship Deleted" // default
},
requeatParam: {
// return example send param
},
status: "string", //default "complete" or "error"
errorsFound: []
}
}

</syntaxhighlight>

== DeleteNode ==
=== Request Parameters ===
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* identifiers
** Type : object
** Required: true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":"xxx",
"objectType":"yyy"
},
"identifiers":{
//
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResults
** Type: object
* queryResults.resultDeleteNode
** Type: Boolean
** Description: return status deleted node >> true or false
* requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
** Description: return status deleted node >> complete or error
* errorsFound
** Type: array
* graphServiceTag
** Type: string
=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: { resultDeleteNode: true }, // true or false
requestParams: {
// return example send param
}
},
status: 'string', // 'complete' or 'error'
errorsFound: [],
graphServiceTag: 'GraphHandler'
}
</syntaxhighlight>

== MoveRelationship ==

=== Request Parameters ===
* sourceObject
** Type : object
** Required : true
** Description: required objType: {serviceTag , objectType} and identifiers
* targetObjType
** Type : object
** Required : true
** Description: required objType: {serviceTag , objectType}
* relType
** Type : object
** Required : true
** Description: required objType: {serviceTag , relationshipTag}
* relationshipDirection
** Type : object
** Required : true
* moveToIdentifiers
** Type : object
** Required : true
* moveByUserId
** Type : String
** Required : true
* originTimestamp
** Type : number
** Required : true
* settings
** Type : object
** Required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"sourceObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyy"
},
"identifiers":{
// identifiers
}
},
"targetObjType":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
}
},
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"rel"
},
"relationshipDirection":"from", // "to"
"moveToIdentifiers":{
// target identifiers
},
"moveByUserId":"xxxx",
"originTimestamp":1234567890,
"settings":{}
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.moveRelationship
** Type: object
* moveRelationship.sourceObject
** Type: object
** Description: return data of sourceObject
* moveRelationship.relationship
** Type: string
** Description: return data of after move relationship
* moveRelationship.moveToObject
** Type: object
** Description: return data of moveToObject
* moveRelationship.historyData
** Type: object
** Description: return properties {old target identifiers and originTimestamp} after moveRelationship
* moveRelationship.userNode
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
moveRelationship: {
sourceObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
}
},
relationship: {
relType: {
serviceTag: 'xxxx',
relationshipTag: 'rel'
},
relationshipProperties: { originTimestamp: 1234567890 }
},
moveToObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: { }
},
historyData: {
relationshipProperties: { }
},
userNode: {
objTypes: [{ serviceTag: 'UserAccount', objectType: 'user' }],
objInstanceFull: { }
}
}
},
requestParam: {
}
}
status: "complete" // or error,
errorsFound: [],
graphServiceTag: 'GraphHandler'
}

</syntaxhighlight>

== MoveNodeProperties ==
=== Request Parameters ===
* sourceObject
** type: object
** required : true
* targetIdentifiers
** type : object
** required : true
* moveProperties
** type : array
** required : true // index minimum = 1
* updateProperties
** type : object
** required : true
* movePropertiesConditions
** type : array
** required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
sourceObject: {
objType: { },
identifier: { }
},
targetIdentifiers: { },
moveProperties: [ ],
updateProperties: { },
movePropertiesConditions: [ // optional
{
checkObject: 'target', // "source" | "target"
onSetObject: 'target', // "source" | "target"
onPassValue: true,
onNotPassCondition: false, // optional
fieldNameConditions: [ ]
}
]
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.moveNodeProperties
** Type: object
* moveNodeProperties.sourceObject
** Type: object
** Description: return data of sourceObject
* moveRelationship.moveFieldToObject
** Type: string
** Description: return data after moveFieldToObject
* moveRelationship.movedFields
** Type: object
** Description: return data field of moveToObject
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String
=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
moveNodeProperties: {
sourceObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: {
identifiers: { },
fields: { }
}
},
moveFieldToObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: { },
fields: {

}
},
movedFields: { Fields: { } } //
}
}
},
requestParam: { },
status: 'complete',
errorsFound: [],
graphServiceTag: 'GraphHandler'
}
</syntaxhighlight>
[[Category:Working documents| 2025-03-06]]

2025-03-06 - Graph Handler Docs

2026-06-03T05:21:13Z

Seagame: /* Request Parameters */

= GraphHandler Function =
== CreateNode ==
'''Use Case of CreateNode''' >>> https://izara.io/wiki/index.php/2025-03-27_Graph_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
* setFieldConditionals
** type : array
** Required : optional
* deepPathConditional
** type : array
** Required : optional
* parentFlowId
** type : string
** Required: true
* callingFlowConfig
** Type: object
** Required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType": {
"objectType": string,
"serviceTag": string
},
"objInstanceFull": {
"identifiers": {
// ...identifier
},
"fields": {
// ...fields
}
},
setFieldConditionals: [ // optional default array
{
objType: { },
indexValue: { nameSpace: 'ex-011', systemTextTag: 'Gate-011' }, // index field : value
fieldName: '', // fieldName want to set
passValue: 'false', optional
notPassValue: 'true', //optional
conditionals: [ optional ] // condition check field
}
],
"relationships": [
{
"relType": {
"serviceTag": string,
"relationshipTag": string
},
"relationshipProperties": {
//... key and value of targetIdentifiers
},
"relationshipDirection": string, // "from" | "to"
"targetObjType": {
"serviceTag": string,
"objectType": string
},
"targetIdentifiers": {
//... targetIdentifiers
}
}
],
deepPathConditional: [ // optional default array
{
condition: 'notExist', //
conditionCheck: { // traversal
nodeStructure: {
objType: { },
fields: { }
},
nextPath: {
relationshipStructure: {
relType: { },
relationshipDirection: 'to'
},
nodeStructure: {
objType: { },
fields: { }
}
}
}
}
],
"originTimestamp": number, // timestamp when create
"settings": {
"updatePropertiesOnMatch": boolean // default=false
},
"parentFlowId": "",
"callingFlow": string,
"callingFlowProperties": object,
}
</syntaxhighlight>

=== 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.relationships
** Type: array
** Description: data from relationships in targetNode
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* Status
** Type: string
** Description: Status from create node. Return "error" or "complete".
* errorsFound
** Type: array
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">

{
returnValue: {
queryResult: {
returnCreateNode: {
objTypes: [
{
serviceTag: "string",
objectType: "string"
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//...fields
}
},
existsNode: { },
userNode: { // // if has userNode send to createNode
objTypes: [
{
"serviceTag": "UserAccount",
"objectType": "user"
}
],
properties: {
//...properties
}
},
relationships: [ // optional : if has requiredOnCreated , createNode with targetNode
{
objTypes: [
{ serviceTag: 'string', objectType: 'string' }
],
objInstanceFull: {
identifiers: {
// identifiers
}
},
relType: {
serviceTag: 'string',
relationshipTag: 'rel'
},
relationshipProperties: {
// properties
}
},
]
}
},
requestParams: {
// return example send param
},
parentFlowId:""
},
status: "string", // "complete' or "error"
errorsFound: [],
graphServiceTag: "GraphHandler"
}

</syntaxhighlight>

== GetNode ==
'''Use Case of GetNode''' >>> https://izara.io/wiki/index.php/2025-04-23_Graph_Use_Case/GetNode_and_GetNodes#Use_Case_GetNodes
=== 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
* versionedDataLabels
** Type: Array
** Required : optional
* settings.updatePropertiesOnMatch
** Type: Boolean
** Required : optional
* parentFlowId
** Type: string
** Required: optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":string,
"objectType":string
},
"objInstanceFull":{
"identifiers":{
// ...identifier
},
"fields":{
// ...fields
}
},
"versionedDataLabels":[
//…versionedData
],
"settings": {
"returnSystemFieldsName" :boolean // default = true or false
}
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* returnValue.queryResult
** Type: object
* queryResult.refactoredNodes
** Type: object
** Description: return object from getNode
* refactoredNodes.objTypes
** Type: array
* refactoredNodes.objInstanceFull
** Type: object
* refactoredNodes.objInstanceFull.identifiers
** Type: object
* refactoredNodes.objInstanceFull.fields
** Type: object
* refactoredNodes.versionDataSystemFields
** Type: object
* refactoredNodes.versionDataSystemFields.versionedDataLabel
** Type: object
* queryResult.requestParam
** Type: object
** Description: return example send param
* errorsFound
** Type: string
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
refactoredNodes: {
objTypes: [
{
serviceTag: "string",
objectType: "string",
}
],
objInstanceFull: {
identifiers: {
//… identifier
},
fields: {
//…fields
}
},
versionDataSystemFields: {
versionedDataLabel: {
originTimestamp: number,
forMatchedId: "string",
versionedDataId: "string"
}
}
}
},
requestParam: {
// return example send param
}
},
errorsFound: [],
graphServiceTag: ''
}
</syntaxhighlight>

== GetNodes ==
'''Use Case of GetNodes''' >>> https://izara.io/wiki/index.php/2025-04-23_Graph_Use_Case/GetNode_and_GetNodes#Use_Case_GetNodes
=== Request Parameters ===
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* fields
** Type : object
** Required: true
* versionedDataLabels
** Type: Array
** Required : optional
* settings.returnSystemFieldsName
** Type: Boolean
** Required : optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":string,
"objectType":string
},
"fields":{
//…fields with matching value
},
"versionedDataLabels":[
//…versionedDataLabels
],
"settings":{
"returnSystemFieldsName":boolean // default=false
}
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResults
** Type: object
* queryResults.getNodesReturnValues
** Type: array
* getNodesReturnValues.objTypes
** Type: array
* getNodesReturnValues.objInstanceFull
** Type: object
* getNodesReturnValues.objInstanceFull.identifiers
** Type: object
* getNodesReturnValues.objInstanceFull.fields
** Type: object
* getNodesReturnValues.versionDataSystemFields
** Type: object
* getNodesReturnValues.versionDataSystemFields.versionedDataLabel
** Type: object
* requestParams
** Type: object
* errorsFound
** Type: string
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: {
getNodesReturnValues: [
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//.. all fields-1
}
},
versionDataSystemFields: {}
},
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//...all fields-2
}
},
versionDataSystemFields: {
versionedDataLabel: {
originTimestamp: number,
forMatchedId: 'string',
versionedDataId: 'string'
}
}
}
]
},
requestParams: {
// return example send param
}
}
}
</syntaxhighlight>

== UpdateNode ==
''' Use Case of UpdateNode''' >>> https://izara.io/wiki/index.php/2025-08-03_-_Graph_Use_Case/UpdateNode
=== 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: object
** Required : true
* objInstanceFull.fields
** Type : object
** Required: true
** Description : can not send fields to update mainNode and versionedData together
* versionedDataIds
** Type: object
** Required: optional
* originTimestamp
** Type: number
** Required: true
* settings
** Type: object
** Required: optional
* callingFlow
** Type: string
** Required: optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType": {
"serviceTag": string,
"objectType": string
},
"objInstanceFull": {
"identifiers": {
//…identifiers
},
"fields": {
//…fields
// can not be send fields of mainNode and versionedData in fields together!
}
},
"versionedDataIds": {},
"originTimestamp": number, //// timestamp when update
"settings": {},
"callingFlow": string
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* returnValue.queryResult
** Type: object
** Description: data from created node
* queryResult.objTypes
** Type: array
** Description: serviceTag and objectType
* queryResult.objInstanceFull
** Type: object
** Description: identifiers and fields
* queryResult.userId
** Type: object
** Description: data that update from user Account
* queryResult.versionDataSystemFields
** Type: object
** Description: optional return versionedData
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* returnValue.Status
** Type: string
** Description: status from updated node // error or complete
* returnValue.errorsFound
** Type: array
* returnValue.graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifiers
},
fields: {
//...fields
}
},
userId: {
// if have userNode send to updated
},
versionDataSystemFields: {
versionedDataLabel: {
}
}
},
requestParams: {
// return example send param
}
},
status: 'string',//"complete" // "error"
errorsFound: [],
graphServiceTag: 'string'
}
</syntaxhighlight>

== CreateRelationship ==
''' Use Case of CreateRelationship''' >>> https://izara.io/wiki/index.php/2025-08-01_-_Graph_Use_Case/CreateRelationship
=== Request Parameters ===
* firstObject
** Type: object
** Required: true
* secondObject
** Type: object
** Required: true
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* identifiers
** Type: object
** Required : true
* createRelationshipIfNothave
** Type : array
** Required: optional
** Description : using createRelationshipIfNothave for check relationship if not has created , can check both firstNode and SeconNode or onCreateAddRelationships
* onCreateAddRelationships
** Type: array of object
** Required: optional
* relType
** Type: object
** Required: true
* relationshipDirection
** Type: string
** Required: true
* relationshipProperties
** Type: object
** Required: true
* Settings
** Type: object
** Required: true
* settings.updateRelPropsWhenExist
** Type: boolean
** Required: optional
* callingFlow
** Type: string
** Required: optional
* callingFlowConfig
** Type: object
** Required: optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject": {
"objType": {
"serviceTag": string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"createRelationshipIfNothave": [ // optional
{
"onMatchRelationship": {
"relType": {
"serviceTag": string,
"relationshipTag": string
},
"relationshipProperties": {},
"relationshipDirection": string
},
"onMatchNode": {
"objType": {
"serviceTag":string,
"objectType": string
},
"fields": {
}
}
}
],
"onCreateAddRelationships": [
{
"objType": {
"serviceTag":string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"relType": {
"serviceTag":string,
"relationshipTag":string
},
"relationshipProperties": {
//…properties
},
"relationshipDirection":string // “from” , “to”
}
]
},
"secondObject": {
"objType": {
"serviceTag":string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"onCreateAddRelationships": [
//…optional
]
},
"relType": {
"serviceTag":string,
"relationshipTag":string
},
"relationshipDirection":string, // “from” , “to”
"relationshipProperties": {
//…properties
},
"settings": {
"updateRelPropsWhenExist": boolean,
},
"callingFlow": "xxxx",
"callingFlowProperties": {
"graphServiceName": string
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.relationship
** Type: object
* queryResult.relationship.relType
** Type: object
* queryResult.relationship.relationshipProperties
** Type: object
* queryResult.firstNode
** Type: object
** Description: return data structure from firstNode
* queryResult.secondNode
** Type: object
** Description: return data structure from secondNode
* queryResult..onCreateAddRelationships
** Type: array
** Description: return data structure from onCreateAddRelationships
* returnValue.firstObject
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* Status
** Type: string
** Description: status from create node // error or complete
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
relationship: {
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//…properties
}
},
firstNode: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: { //… identifiers },
fields: {
//… all fields
}
},
onCreateAddRelationships: [
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//… identifiers
},
fields: {
//… all fields
}
},
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//… all properties
}
}
]
},
secondNode: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: { //… identifiers },
fields: {
//… all fields
}
},
onCreateAddRelationships: [
//… optional
]
}
}
}
}
requestParams: {
// return example send param

},
Status: 'string', //“complete” // “error”
errorsFound: []
}
}
</syntaxhighlight>

== GetRelationship ==
=== Request Parameters ===
* firstObject
** Type: object
** Required: optional
* secondObject
** Type: object
** Required: optional
* objType
** Type: object
** Required: true
** Description: has serviceTag and objectType
* identifiers
** Type: object
** Required: true
* relType
** Type: object
** Required: true
** Description: has relationshipTag and serviceTag
* relId
** Type: string
** Required: true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag":string,
"objectType":string
},
"identifiers":{
//…identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"relType":{ // required
"relationshipTag": string,
"serviceTag": string
},
"relId": 'string' // // required
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
* Type: object
* queryResult.relType
** Type: object
* queryResult.relationshipProperties
** Type: object
** Description: return relId and properties
* returnValue.toObject
** Type: object
** Description: return toObject if not send secondObject from param
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* errorsFound
** Type: array
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: {
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//…properties : 'string’
}
},
toObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: {
identifiers: {
//
},
fields: { }
}
},
requestParams: {
// return example send param
}
}
}

</syntaxhighlight>

== UpdateRelationship ==
=== Request Parameters ===
* firstObject
** Type: object
** Required: optional
* secondObject
** Type: object
** Required: Optional
* objType
** Type: object
** Required: true
** Description: has serviceTag and objectType
* identifiers
** Type: object
** Required: true
* relId
** Type: string
** Required: true
* relType
** Type: object
** Required: true
** Description: has relationshipTag and serviceTag
* relationshipProperties
** Type: object
** Required: true
** Description: send properties that want to update
* relationshipDirection
** Type: string
** Required: optional
* callingFlow
** Type: string
** Required: optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"relId": string,
"relType":{
"serviceTag":string,
"relationshipTag":string
},
"relationshipProperties":{
//… properties that want to update
},
"relationshipDirection": string, // "from" // “to”
"callingFlow": string
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.firstObject And secondObject
** Type: object
** Description : return objType {seviceTag and objectType} And identifiers
* queryResult.relId
** Type: string
* queryResult.relType
** Type: object
** Description: return {seviceTag and relationshipTag}
* queryResult.relationshipDirection
** Type: string
* queryResult.updatePropertiesParam
** Type: object
** Description: return properties to updated
* queryResult.oldRelationshipProperties
** Type: object
** Description: return old properties before update
* queryResult.newRelationshipProperties
** Type: object
** Description: return new properties after updated
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type : string
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
firstObject: {
objType: {
serviceTag: "string",
objectType: "string"
},
identifiers: {
//…identifiers
}
},
secondObject: {
objType: {
serviceTag: "string",
objectType: "string"
},
identifiers: {
//…identifiers
}
},
relId: "string",
relType: {
serviceTag: "string",
relationshipTag: "string"
},
relationshipDirection: "string",
updatePropertiesParam: {
//… properties updated
},
oldRelationshipProperties: {
// … old properties before update
},
newRelationshipProperties: {
//… new properties after updated
}
}
},
requestParams: {
// return example send param
}
status: “string”, // "complete",”error”
errorsFound: []
}
</syntaxhighlight>

== GetNodeAndRelationship ==
=== Request Parameters ===
* sourceObjType
** Required: true
** Description: has serviceTag and objectType
* sourceIdentifiers
** Type: object
** Required: true
* sourceVersionedDataLabels
** Type: object
** Required: optional
* targetRelationships
** Type: Array
** Required: true
* relTypeAndDirection
** Type: object
** Required: true
* relTypeAndDirection.relType
** Type: object
** Required: true
** Description: has serviceTag and relationshipTag
* relTypeAndDirection.relationshipProperties
** Type: object
** Required: optional
* relTypeAndDirection.relationshipDirection
** Type: String
** Required: optional
* targetObjects
** Type: Array
** Required: Optional
* targetObjects.objType
** Type: object
** Required: required if send targetObjects in param
* targetObjects.identifiers
** Type: object
** Required: optional should have objType if identifiers exists
* targetObjects.versionedDataLabels
** Type: object
** Required: optional have objType if versionedDataLabels exists

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"sourceObjType": { // required
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"sourceIdentifiers": {}, // required
"sourceVersionedDataLabels": [], // optional
"targetRelationships": [ //required
{
"relTypeAndDirection": { // required
"relType": {
"serviceTag": "xxxx",
"relationshipTag": "rel"
},
"relationshipProperties": {},//optional
"relationshipDirection": "" // required
},
"targetObjects": [ // optional
{
"objType": {
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"identifiers": {}, // optional
"versionedDataLabels": [] // optional have objType if versionedDataLabels exists
}
]
},
// if have multiple relTypeAndDirection
],
"settings": {} // defaulf = false >>> if have versionedDataLabels want to return all field of versionedata: settings = { returnSystemFieldsName: true }
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.objTypes
** Type: array of object
** Description: return {serviceTag and objectType}
* queryResult.objInstanceFull
** Type: object
** Description: return {identifiers and fields}
* queryResult.relNodes:
** Type: array
* relNodes.relType
** Type: object
** Description: return {serviceTag and relationshipTag}
* relNodes.relationshipProperties
** Type: object
* relNodes.objTypes
** Type: array of object
** Description: return {serviceTag and objectType}
* relNodes.objInstanceFull
** Type: object
** Description: return {identifiers and fields}
* requestParams
** Type: object
** Description: return same requestParams
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: {},
fields: { }
},
relNodes: [
{
relType: {
serviceTag: 'xxxx',
relationshipTag: 'rel'
},
relationshipProperties: { },
objTypes: [
{
serviceTag: 'xxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: {},
fields: {
// field
}
},
versionDataSystemFields: {
'0VersionDataLabel': {
originTimestamp:
forMatchedId:
versionedDataId:
}
}
}
]
}
},
requestParam : {
// return example send param
},
errorsFound: [],
graphServiceTag: "GraphHandler"
}

</syntaxhighlight>

== ChangeRelationshipType ==
=== Request Parameters ===
* firstObject
** Type : object
** Required : true
* secondObject
** Type : object
** Required : true
* objType
** Type : object
** Required : true
* Identifiers
** Type : object
** Required : true
* oldRelTypeAndDirection
** Type : object
** Required : true
* oldRelTypeAndDirection.relType
** Type : object
** Required : true
* oldRelTypeAndDirection.relationshipDirection
** Type : string
** Required : true
* oldRelTypeAndDirection.relationshipProperties
** Type : object
** Required : optional
* newRelType
** Type : object
** Required : true
* originTimestamp
** Type : number
** Required : true
* changedByUserId
** Type : String
** Required : true
* callingFlow
** Type : String
** Required : optional
* settings
** Type : object
** Required : optional
** Description : default > settings.changeMultipleRelationships : false // if send settings.changeMultipleRelationships : true >> can change multiple relType

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"secondObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"oldRelTypeAndDirection":{
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"old"
},
"relationshipDirection":"from",
"relationshipProperties":{
//Properties
}
},
"newRelType":{
"serviceTag":"xxxx",
"relationshipTag":"new"
},
"originTimestamp":1234567890,
"changedByUserId":"xxxx",
"callingFlow":"yyyy",
"settings":{
"changeMultipleRelationships": boolean: // default false
}
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.newRelationshipType
** Type: object
* newRelationshipType.relType
** Type: object
* newRelationshipType.relationshipDirection
** Type: string
* newRelationshipType.relationshipProperties
** Type: object
* queryResult.oldRelationshipType
** Type: object
* oldRelationshipType.relType
** Type: object
* oldRelationshipType.relationshipDirection
** Type: string
* oldRelationshipType.relationshipProperties
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
newRelationshipType: {
relType: {
serviceTag: "xxxx",
relationshipTag: "new"
},
relationshipDirection: "" // 'from' or 'to'
relationshipProperties: {}
},
oldRelationshipType: {
relType: {
serviceTag: "xxxx",
relationshipTag: "old"
},
relationshipDirection: "" // 'from' or 'to'
relationshipProperties: {}
}
},
requestParams : {
// return example send param
}
},
status: "complete" // or error,
errorsFound: [],
graphServiceTag : 'GraphHandeler'
}

</syntaxhighlight>

== DeleteRelationship ==
=== Request Parameters ===
* fromObject
** Type : object
** Required : optional
* secondObject
** Type : object
** Required : optional
* objType
** Type : object
** Required : true
* Identifiers
** Type : object
** Required : true
* relType
** Type : object
** Required : true
* relId
** Type: string
** Required : true
* relationshipDirection
** Type: string
** Required : optional
* callingFlow
** Type: string
** Required : true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"yyyy"
},
"relId":"string"
},
"relationshipDirection":"string"// "from" or "to"
"callingFlow":"string"
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.objects
** Type: array
* queryResult.objTypes
** Type: array
* queryResult.objInstanceFull.identifiers
** Type: object
* queryResult.objInstanceFull.fields
** Type: object
** Description: return data of fromObject and secondObject
* queryResult.userNode
** Type: object
** Description: return data of userNode
* queryResult.resultDeleteRel
** Type : string
** Description: return status Relationship Delete
* requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objects: [
{
objTypes: [
{
serviceTag: "xxxx",
objectType: "yyyy"
}
],
objInstanceFull: {
identifiers: {
// identifiers
},
fields: {
// fields
}
}
},
{
// if have multiple object objTypes
}
],
userNode: {
objTypes: [
{
serviceTag: "UserAccount",
objectType: "user"
}
],
objInstanceFull: {
identifiers: {
userId: "zzz"
}
}
},
resultDeleteRel: "Relationship Deleted" // default
},
requeatParam: {
// return example send param
},
status: "string", //default "complete" or "error"
errorsFound: []
}
}

</syntaxhighlight>

== DeleteNode ==
=== Request Parameters ===
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* identifiers
** Type : object
** Required: true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":"xxx",
"objectType":"yyy"
},
"identifiers":{
//
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResults
** Type: object
* queryResults.resultDeleteNode
** Type: Boolean
** Description: return status deleted node >> true or false
* requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
** Description: return status deleted node >> complete or error
* errorsFound
** Type: array
* graphServiceTag
** Type: string
=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: { resultDeleteNode: true }, // true or false
requestParams: {
// return example send param
}
},
status: 'string', // 'complete' or 'error'
errorsFound: [],
graphServiceTag: 'GraphHandler'
}
</syntaxhighlight>

== MoveRelationship ==

=== Request Parameters ===
* sourceObject
** Type : object
** Required : true
** Description: required objType: {serviceTag , objectType} and identifiers
* targetObjType
** Type : object
** Required : true
** Description: required objType: {serviceTag , objectType}
* relType
** Type : object
** Required : true
** Description: required objType: {serviceTag , relationshipTag}
* relationshipDirection
** Type : object
** Required : true
* moveToIdentifiers
** Type : object
** Required : true
* moveByUserId
** Type : String
** Required : true
* originTimestamp
** Type : number
** Required : true
* settings
** Type : object
** Required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"sourceObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyy"
},
"identifiers":{
// identifiers
}
},
"targetObjType":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
}
},
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"rel"
},
"relationshipDirection":"from", // "to"
"moveToIdentifiers":{
// target identifiers
},
"moveByUserId":"xxxx",
"originTimestamp":1234567890,
"settings":{}
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.moveRelationship
** Type: object
* moveRelationship.sourceObject
** Type: object
** Description: return data of sourceObject
* moveRelationship.relationship
** Type: string
** Description: return data of after move relationship
* moveRelationship.moveToObject
** Type: object
** Description: return data of moveToObject
* moveRelationship.historyData
** Type: object
** Description: return properties {old target identifiers and originTimestamp} after moveRelationship
* moveRelationship.userNode
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
moveRelationship: {
sourceObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
}
},
relationship: {
relType: {
serviceTag: 'xxxx',
relationshipTag: 'rel'
},
relationshipProperties: { originTimestamp: 1234567890 }
},
moveToObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: { }
},
historyData: {
relationshipProperties: { }
},
userNode: {
objTypes: [{ serviceTag: 'UserAccount', objectType: 'user' }],
objInstanceFull: { }
}
}
},
requestParam: {
}
}
status: "complete" // or error,
errorsFound: [],
graphServiceTag: 'GraphHandler'
}

</syntaxhighlight>

== MoveNodeProperties ==
=== Request Parameters ===
* sourceObject
** type: object
** required : true
* targetIdentifiers
** type : object
** required : true
* moveProperties
** type : array
** required : true // index minimum = 1
* updateProperties
** type : object
** required : true
* movePropertiesConditions
** type : array
** required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
sourceObject: {
objType: { },
identifier: { }
},
targetIdentifiers: { },
moveProperties: [ ],
updateProperties: { },
movePropertiesConditions: [ // optional
{
checkObject: 'target', // "source" | "target"
onSetObject: 'target', // "source" | "target"
onPassValue: true,
onNotPassCondition: false, // optional
fieldNameConditions: [ ]
}
]
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.moveNodeProperties
** Type: object
* moveNodeProperties.sourceObject
** Type: object
** Description: return data of sourceObject
* moveRelationship.moveFieldToObject
** Type: string
** Description: return data after moveFieldToObject
* moveRelationship.movedFields
** Type: object
** Description: return data field of moveToObject
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String
=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
moveNodeProperties: {
sourceObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: {
identifiers: { },
fields: { }
}
},
moveFieldToObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: { },
fields: {

}
},
movedFields: { Fields: { } } //
}
}
},
requestParam: { },
status: 'complete',
errorsFound: [],
graphServiceTag: 'GraphHandler'
}
</syntaxhighlight>
[[Category:Working documents| 2025-03-06]]

2025-03-06 - Graph Handler Docs

2026-06-03T05:19:52Z

Seagame: /* Return Example */

= GraphHandler Function =
== CreateNode ==
'''Use Case of CreateNode''' >>> https://izara.io/wiki/index.php/2025-03-27_Graph_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
* setFieldConditionals
** type : array
** Required : optional
* deepPathConditional
** type : array
** Required : optional
* parentFlowId
** type : string
** Required: true
* callingFlowConfig
** Type: object
** Required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType": {
"objectType": string,
"serviceTag": string
},
"objInstanceFull": {
"identifiers": {
// ...identifier
},
"fields": {
// ...fields
}
},
setFieldConditionals: [ // optional default array
{
objType: { },
indexValue: { nameSpace: 'ex-011', systemTextTag: 'Gate-011' }, // index field : value
fieldName: '', // fieldName want to set
passValue: 'false', optional
notPassValue: 'true', //optional
conditionals: [ optional ] // condition check field
}
],
"relationships": [
{
"relType": {
"serviceTag": string,
"relationshipTag": string
},
"relationshipProperties": {
//... key and value of targetIdentifiers
},
"relationshipDirection": string, // "from" | "to"
"targetObjType": {
"serviceTag": string,
"objectType": string
},
"targetIdentifiers": {
//... targetIdentifiers
}
}
],
deepPathConditional: [ // optional default array
{
condition: 'notExist', //
conditionCheck: { // traversal
nodeStructure: {
objType: { },
fields: { }
},
nextPath: {
relationshipStructure: {
relType: { },
relationshipDirection: 'to'
},
nodeStructure: {
objType: { },
fields: { }
}
}
}
}
],
"originTimestamp": number, // timestamp when create
"settings": {
"updatePropertiesOnMatch": boolean // default=false
},
"parentFlowId": "",
"callingFlow": string,
"callingFlowProperties": object,
}
</syntaxhighlight>

=== 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.relationships
** Type: array
** Description: data from relationships in targetNode
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* Status
** Type: string
** Description: Status from create node. Return "error" or "complete".
* errorsFound
** Type: array
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">

{
returnValue: {
queryResult: {
returnCreateNode: {
objTypes: [
{
serviceTag: "string",
objectType: "string"
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//...fields
}
},
existsNode: { },
userNode: { // // if has userNode send to createNode
objTypes: [
{
"serviceTag": "UserAccount",
"objectType": "user"
}
],
properties: {
//...properties
}
},
relationships: [ // optional : if has requiredOnCreated , createNode with targetNode
{
objTypes: [
{ serviceTag: 'string', objectType: 'string' }
],
objInstanceFull: {
identifiers: {
// identifiers
}
},
relType: {
serviceTag: 'string',
relationshipTag: 'rel'
},
relationshipProperties: {
// properties
}
},
]
}
},
requestParams: {
// return example send param
},
parentFlowId:""
},
status: "string", // "complete' or "error"
errorsFound: [],
graphServiceTag: "GraphHandler"
}

</syntaxhighlight>

== GetNode ==
'''Use Case of GetNode''' >>> https://izara.io/wiki/index.php/2025-04-23_Graph_Use_Case/GetNode_and_GetNodes#Use_Case_GetNodes
=== 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
* versionedDataLabels
** Type: Array
** Required : optional
* settings.updatePropertiesOnMatch
** Type: Boolean
** Required : optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":string,
"objectType":string
},
"objInstanceFull":{
"identifiers":{
// ...identifier
},
"fields":{
// ...fields
}
},
"versionedDataLabels":[
//…versionedData
],
"settings": {
"returnSystemFieldsName" :boolean // default = true or false
}
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* returnValue.queryResult
** Type: object
* queryResult.refactoredNodes
** Type: object
** Description: return object from getNode
* refactoredNodes.objTypes
** Type: array
* refactoredNodes.objInstanceFull
** Type: object
* refactoredNodes.objInstanceFull.identifiers
** Type: object
* refactoredNodes.objInstanceFull.fields
** Type: object
* refactoredNodes.versionDataSystemFields
** Type: object
* refactoredNodes.versionDataSystemFields.versionedDataLabel
** Type: object
* queryResult.requestParam
** Type: object
** Description: return example send param
* errorsFound
** Type: string
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
refactoredNodes: {
objTypes: [
{
serviceTag: "string",
objectType: "string",
}
],
objInstanceFull: {
identifiers: {
//… identifier
},
fields: {
//…fields
}
},
versionDataSystemFields: {
versionedDataLabel: {
originTimestamp: number,
forMatchedId: "string",
versionedDataId: "string"
}
}
}
},
requestParam: {
// return example send param
}
},
errorsFound: [],
graphServiceTag: ''
}
</syntaxhighlight>

== GetNodes ==
'''Use Case of GetNodes''' >>> https://izara.io/wiki/index.php/2025-04-23_Graph_Use_Case/GetNode_and_GetNodes#Use_Case_GetNodes
=== Request Parameters ===
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* fields
** Type : object
** Required: true
* versionedDataLabels
** Type: Array
** Required : optional
* settings.returnSystemFieldsName
** Type: Boolean
** Required : optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":string,
"objectType":string
},
"fields":{
//…fields with matching value
},
"versionedDataLabels":[
//…versionedDataLabels
],
"settings":{
"returnSystemFieldsName":boolean // default=false
}
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResults
** Type: object
* queryResults.getNodesReturnValues
** Type: array
* getNodesReturnValues.objTypes
** Type: array
* getNodesReturnValues.objInstanceFull
** Type: object
* getNodesReturnValues.objInstanceFull.identifiers
** Type: object
* getNodesReturnValues.objInstanceFull.fields
** Type: object
* getNodesReturnValues.versionDataSystemFields
** Type: object
* getNodesReturnValues.versionDataSystemFields.versionedDataLabel
** Type: object
* requestParams
** Type: object
* errorsFound
** Type: string
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: {
getNodesReturnValues: [
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//.. all fields-1
}
},
versionDataSystemFields: {}
},
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//...all fields-2
}
},
versionDataSystemFields: {
versionedDataLabel: {
originTimestamp: number,
forMatchedId: 'string',
versionedDataId: 'string'
}
}
}
]
},
requestParams: {
// return example send param
}
}
}
</syntaxhighlight>

== UpdateNode ==
''' Use Case of UpdateNode''' >>> https://izara.io/wiki/index.php/2025-08-03_-_Graph_Use_Case/UpdateNode
=== 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: object
** Required : true
* objInstanceFull.fields
** Type : object
** Required: true
** Description : can not send fields to update mainNode and versionedData together
* versionedDataIds
** Type: object
** Required: optional
* originTimestamp
** Type: number
** Required: true
* settings
** Type: object
** Required: optional
* callingFlow
** Type: string
** Required: optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType": {
"serviceTag": string,
"objectType": string
},
"objInstanceFull": {
"identifiers": {
//…identifiers
},
"fields": {
//…fields
// can not be send fields of mainNode and versionedData in fields together!
}
},
"versionedDataIds": {},
"originTimestamp": number, //// timestamp when update
"settings": {},
"callingFlow": string
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* returnValue.queryResult
** Type: object
** Description: data from created node
* queryResult.objTypes
** Type: array
** Description: serviceTag and objectType
* queryResult.objInstanceFull
** Type: object
** Description: identifiers and fields
* queryResult.userId
** Type: object
** Description: data that update from user Account
* queryResult.versionDataSystemFields
** Type: object
** Description: optional return versionedData
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* returnValue.Status
** Type: string
** Description: status from updated node // error or complete
* returnValue.errorsFound
** Type: array
* returnValue.graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifiers
},
fields: {
//...fields
}
},
userId: {
// if have userNode send to updated
},
versionDataSystemFields: {
versionedDataLabel: {
}
}
},
requestParams: {
// return example send param
}
},
status: 'string',//"complete" // "error"
errorsFound: [],
graphServiceTag: 'string'
}
</syntaxhighlight>

== CreateRelationship ==
''' Use Case of CreateRelationship''' >>> https://izara.io/wiki/index.php/2025-08-01_-_Graph_Use_Case/CreateRelationship
=== Request Parameters ===
* firstObject
** Type: object
** Required: true
* secondObject
** Type: object
** Required: true
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* identifiers
** Type: object
** Required : true
* createRelationshipIfNothave
** Type : array
** Required: optional
** Description : using createRelationshipIfNothave for check relationship if not has created , can check both firstNode and SeconNode or onCreateAddRelationships
* onCreateAddRelationships
** Type: array of object
** Required: optional
* relType
** Type: object
** Required: true
* relationshipDirection
** Type: string
** Required: true
* relationshipProperties
** Type: object
** Required: true
* Settings
** Type: object
** Required: true
* settings.updateRelPropsWhenExist
** Type: boolean
** Required: optional
* callingFlow
** Type: string
** Required: optional
* callingFlowConfig
** Type: object
** Required: optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject": {
"objType": {
"serviceTag": string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"createRelationshipIfNothave": [ // optional
{
"onMatchRelationship": {
"relType": {
"serviceTag": string,
"relationshipTag": string
},
"relationshipProperties": {},
"relationshipDirection": string
},
"onMatchNode": {
"objType": {
"serviceTag":string,
"objectType": string
},
"fields": {
}
}
}
],
"onCreateAddRelationships": [
{
"objType": {
"serviceTag":string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"relType": {
"serviceTag":string,
"relationshipTag":string
},
"relationshipProperties": {
//…properties
},
"relationshipDirection":string // “from” , “to”
}
]
},
"secondObject": {
"objType": {
"serviceTag":string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"onCreateAddRelationships": [
//…optional
]
},
"relType": {
"serviceTag":string,
"relationshipTag":string
},
"relationshipDirection":string, // “from” , “to”
"relationshipProperties": {
//…properties
},
"settings": {
"updateRelPropsWhenExist": boolean,
},
"callingFlow": "xxxx",
"callingFlowProperties": {
"graphServiceName": string
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.relationship
** Type: object
* queryResult.relationship.relType
** Type: object
* queryResult.relationship.relationshipProperties
** Type: object
* queryResult.firstNode
** Type: object
** Description: return data structure from firstNode
* queryResult.secondNode
** Type: object
** Description: return data structure from secondNode
* queryResult..onCreateAddRelationships
** Type: array
** Description: return data structure from onCreateAddRelationships
* returnValue.firstObject
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* Status
** Type: string
** Description: status from create node // error or complete
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
relationship: {
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//…properties
}
},
firstNode: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: { //… identifiers },
fields: {
//… all fields
}
},
onCreateAddRelationships: [
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//… identifiers
},
fields: {
//… all fields
}
},
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//… all properties
}
}
]
},
secondNode: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: { //… identifiers },
fields: {
//… all fields
}
},
onCreateAddRelationships: [
//… optional
]
}
}
}
}
requestParams: {
// return example send param

},
Status: 'string', //“complete” // “error”
errorsFound: []
}
}
</syntaxhighlight>

== GetRelationship ==
=== Request Parameters ===
* firstObject
** Type: object
** Required: optional
* secondObject
** Type: object
** Required: optional
* objType
** Type: object
** Required: true
** Description: has serviceTag and objectType
* identifiers
** Type: object
** Required: true
* relType
** Type: object
** Required: true
** Description: has relationshipTag and serviceTag
* relId
** Type: string
** Required: true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag":string,
"objectType":string
},
"identifiers":{
//…identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"relType":{ // required
"relationshipTag": string,
"serviceTag": string
},
"relId": 'string' // // required
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
* Type: object
* queryResult.relType
** Type: object
* queryResult.relationshipProperties
** Type: object
** Description: return relId and properties
* returnValue.toObject
** Type: object
** Description: return toObject if not send secondObject from param
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* errorsFound
** Type: array
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: {
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//…properties : 'string’
}
},
toObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: {
identifiers: {
//
},
fields: { }
}
},
requestParams: {
// return example send param
}
}
}

</syntaxhighlight>

== UpdateRelationship ==
=== Request Parameters ===
* firstObject
** Type: object
** Required: optional
* secondObject
** Type: object
** Required: Optional
* objType
** Type: object
** Required: true
** Description: has serviceTag and objectType
* identifiers
** Type: object
** Required: true
* relId
** Type: string
** Required: true
* relType
** Type: object
** Required: true
** Description: has relationshipTag and serviceTag
* relationshipProperties
** Type: object
** Required: true
** Description: send properties that want to update
* relationshipDirection
** Type: string
** Required: optional
* callingFlow
** Type: string
** Required: optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"relId": string,
"relType":{
"serviceTag":string,
"relationshipTag":string
},
"relationshipProperties":{
//… properties that want to update
},
"relationshipDirection": string, // "from" // “to”
"callingFlow": string
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.firstObject And secondObject
** Type: object
** Description : return objType {seviceTag and objectType} And identifiers
* queryResult.relId
** Type: string
* queryResult.relType
** Type: object
** Description: return {seviceTag and relationshipTag}
* queryResult.relationshipDirection
** Type: string
* queryResult.updatePropertiesParam
** Type: object
** Description: return properties to updated
* queryResult.oldRelationshipProperties
** Type: object
** Description: return old properties before update
* queryResult.newRelationshipProperties
** Type: object
** Description: return new properties after updated
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type : string
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
firstObject: {
objType: {
serviceTag: "string",
objectType: "string"
},
identifiers: {
//…identifiers
}
},
secondObject: {
objType: {
serviceTag: "string",
objectType: "string"
},
identifiers: {
//…identifiers
}
},
relId: "string",
relType: {
serviceTag: "string",
relationshipTag: "string"
},
relationshipDirection: "string",
updatePropertiesParam: {
//… properties updated
},
oldRelationshipProperties: {
// … old properties before update
},
newRelationshipProperties: {
//… new properties after updated
}
}
},
requestParams: {
// return example send param
}
status: “string”, // "complete",”error”
errorsFound: []
}
</syntaxhighlight>

== GetNodeAndRelationship ==
=== Request Parameters ===
* sourceObjType
** Required: true
** Description: has serviceTag and objectType
* sourceIdentifiers
** Type: object
** Required: true
* sourceVersionedDataLabels
** Type: object
** Required: optional
* targetRelationships
** Type: Array
** Required: true
* relTypeAndDirection
** Type: object
** Required: true
* relTypeAndDirection.relType
** Type: object
** Required: true
** Description: has serviceTag and relationshipTag
* relTypeAndDirection.relationshipProperties
** Type: object
** Required: optional
* relTypeAndDirection.relationshipDirection
** Type: String
** Required: optional
* targetObjects
** Type: Array
** Required: Optional
* targetObjects.objType
** Type: object
** Required: required if send targetObjects in param
* targetObjects.identifiers
** Type: object
** Required: optional should have objType if identifiers exists
* targetObjects.versionedDataLabels
** Type: object
** Required: optional have objType if versionedDataLabels exists

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"sourceObjType": { // required
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"sourceIdentifiers": {}, // required
"sourceVersionedDataLabels": [], // optional
"targetRelationships": [ //required
{
"relTypeAndDirection": { // required
"relType": {
"serviceTag": "xxxx",
"relationshipTag": "rel"
},
"relationshipProperties": {},//optional
"relationshipDirection": "" // required
},
"targetObjects": [ // optional
{
"objType": {
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"identifiers": {}, // optional
"versionedDataLabels": [] // optional have objType if versionedDataLabels exists
}
]
},
// if have multiple relTypeAndDirection
],
"settings": {} // defaulf = false >>> if have versionedDataLabels want to return all field of versionedata: settings = { returnSystemFieldsName: true }
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.objTypes
** Type: array of object
** Description: return {serviceTag and objectType}
* queryResult.objInstanceFull
** Type: object
** Description: return {identifiers and fields}
* queryResult.relNodes:
** Type: array
* relNodes.relType
** Type: object
** Description: return {serviceTag and relationshipTag}
* relNodes.relationshipProperties
** Type: object
* relNodes.objTypes
** Type: array of object
** Description: return {serviceTag and objectType}
* relNodes.objInstanceFull
** Type: object
** Description: return {identifiers and fields}
* requestParams
** Type: object
** Description: return same requestParams
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: {},
fields: { }
},
relNodes: [
{
relType: {
serviceTag: 'xxxx',
relationshipTag: 'rel'
},
relationshipProperties: { },
objTypes: [
{
serviceTag: 'xxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: {},
fields: {
// field
}
},
versionDataSystemFields: {
'0VersionDataLabel': {
originTimestamp:
forMatchedId:
versionedDataId:
}
}
}
]
}
},
requestParam : {
// return example send param
},
errorsFound: [],
graphServiceTag: "GraphHandler"
}

</syntaxhighlight>

== ChangeRelationshipType ==
=== Request Parameters ===
* firstObject
** Type : object
** Required : true
* secondObject
** Type : object
** Required : true
* objType
** Type : object
** Required : true
* Identifiers
** Type : object
** Required : true
* oldRelTypeAndDirection
** Type : object
** Required : true
* oldRelTypeAndDirection.relType
** Type : object
** Required : true
* oldRelTypeAndDirection.relationshipDirection
** Type : string
** Required : true
* oldRelTypeAndDirection.relationshipProperties
** Type : object
** Required : optional
* newRelType
** Type : object
** Required : true
* originTimestamp
** Type : number
** Required : true
* changedByUserId
** Type : String
** Required : true
* callingFlow
** Type : String
** Required : optional
* settings
** Type : object
** Required : optional
** Description : default > settings.changeMultipleRelationships : false // if send settings.changeMultipleRelationships : true >> can change multiple relType

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"secondObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"oldRelTypeAndDirection":{
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"old"
},
"relationshipDirection":"from",
"relationshipProperties":{
//Properties
}
},
"newRelType":{
"serviceTag":"xxxx",
"relationshipTag":"new"
},
"originTimestamp":1234567890,
"changedByUserId":"xxxx",
"callingFlow":"yyyy",
"settings":{
"changeMultipleRelationships": boolean: // default false
}
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.newRelationshipType
** Type: object
* newRelationshipType.relType
** Type: object
* newRelationshipType.relationshipDirection
** Type: string
* newRelationshipType.relationshipProperties
** Type: object
* queryResult.oldRelationshipType
** Type: object
* oldRelationshipType.relType
** Type: object
* oldRelationshipType.relationshipDirection
** Type: string
* oldRelationshipType.relationshipProperties
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
newRelationshipType: {
relType: {
serviceTag: "xxxx",
relationshipTag: "new"
},
relationshipDirection: "" // 'from' or 'to'
relationshipProperties: {}
},
oldRelationshipType: {
relType: {
serviceTag: "xxxx",
relationshipTag: "old"
},
relationshipDirection: "" // 'from' or 'to'
relationshipProperties: {}
}
},
requestParams : {
// return example send param
}
},
status: "complete" // or error,
errorsFound: [],
graphServiceTag : 'GraphHandeler'
}

</syntaxhighlight>

== DeleteRelationship ==
=== Request Parameters ===
* fromObject
** Type : object
** Required : optional
* secondObject
** Type : object
** Required : optional
* objType
** Type : object
** Required : true
* Identifiers
** Type : object
** Required : true
* relType
** Type : object
** Required : true
* relId
** Type: string
** Required : true
* relationshipDirection
** Type: string
** Required : optional
* callingFlow
** Type: string
** Required : true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"yyyy"
},
"relId":"string"
},
"relationshipDirection":"string"// "from" or "to"
"callingFlow":"string"
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.objects
** Type: array
* queryResult.objTypes
** Type: array
* queryResult.objInstanceFull.identifiers
** Type: object
* queryResult.objInstanceFull.fields
** Type: object
** Description: return data of fromObject and secondObject
* queryResult.userNode
** Type: object
** Description: return data of userNode
* queryResult.resultDeleteRel
** Type : string
** Description: return status Relationship Delete
* requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objects: [
{
objTypes: [
{
serviceTag: "xxxx",
objectType: "yyyy"
}
],
objInstanceFull: {
identifiers: {
// identifiers
},
fields: {
// fields
}
}
},
{
// if have multiple object objTypes
}
],
userNode: {
objTypes: [
{
serviceTag: "UserAccount",
objectType: "user"
}
],
objInstanceFull: {
identifiers: {
userId: "zzz"
}
}
},
resultDeleteRel: "Relationship Deleted" // default
},
requeatParam: {
// return example send param
},
status: "string", //default "complete" or "error"
errorsFound: []
}
}

</syntaxhighlight>

== DeleteNode ==
=== Request Parameters ===
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* identifiers
** Type : object
** Required: true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":"xxx",
"objectType":"yyy"
},
"identifiers":{
//
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResults
** Type: object
* queryResults.resultDeleteNode
** Type: Boolean
** Description: return status deleted node >> true or false
* requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
** Description: return status deleted node >> complete or error
* errorsFound
** Type: array
* graphServiceTag
** Type: string
=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: { resultDeleteNode: true }, // true or false
requestParams: {
// return example send param
}
},
status: 'string', // 'complete' or 'error'
errorsFound: [],
graphServiceTag: 'GraphHandler'
}
</syntaxhighlight>

== MoveRelationship ==

=== Request Parameters ===
* sourceObject
** Type : object
** Required : true
** Description: required objType: {serviceTag , objectType} and identifiers
* targetObjType
** Type : object
** Required : true
** Description: required objType: {serviceTag , objectType}
* relType
** Type : object
** Required : true
** Description: required objType: {serviceTag , relationshipTag}
* relationshipDirection
** Type : object
** Required : true
* moveToIdentifiers
** Type : object
** Required : true
* moveByUserId
** Type : String
** Required : true
* originTimestamp
** Type : number
** Required : true
* settings
** Type : object
** Required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"sourceObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyy"
},
"identifiers":{
// identifiers
}
},
"targetObjType":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
}
},
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"rel"
},
"relationshipDirection":"from", // "to"
"moveToIdentifiers":{
// target identifiers
},
"moveByUserId":"xxxx",
"originTimestamp":1234567890,
"settings":{}
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.moveRelationship
** Type: object
* moveRelationship.sourceObject
** Type: object
** Description: return data of sourceObject
* moveRelationship.relationship
** Type: string
** Description: return data of after move relationship
* moveRelationship.moveToObject
** Type: object
** Description: return data of moveToObject
* moveRelationship.historyData
** Type: object
** Description: return properties {old target identifiers and originTimestamp} after moveRelationship
* moveRelationship.userNode
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
moveRelationship: {
sourceObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
}
},
relationship: {
relType: {
serviceTag: 'xxxx',
relationshipTag: 'rel'
},
relationshipProperties: { originTimestamp: 1234567890 }
},
moveToObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: { }
},
historyData: {
relationshipProperties: { }
},
userNode: {
objTypes: [{ serviceTag: 'UserAccount', objectType: 'user' }],
objInstanceFull: { }
}
}
},
requestParam: {
}
}
status: "complete" // or error,
errorsFound: [],
graphServiceTag: 'GraphHandler'
}

</syntaxhighlight>

== MoveNodeProperties ==
=== Request Parameters ===
* sourceObject
** type: object
** required : true
* targetIdentifiers
** type : object
** required : true
* moveProperties
** type : array
** required : true // index minimum = 1
* updateProperties
** type : object
** required : true
* movePropertiesConditions
** type : array
** required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
sourceObject: {
objType: { },
identifier: { }
},
targetIdentifiers: { },
moveProperties: [ ],
updateProperties: { },
movePropertiesConditions: [ // optional
{
checkObject: 'target', // "source" | "target"
onSetObject: 'target', // "source" | "target"
onPassValue: true,
onNotPassCondition: false, // optional
fieldNameConditions: [ ]
}
]
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.moveNodeProperties
** Type: object
* moveNodeProperties.sourceObject
** Type: object
** Description: return data of sourceObject
* moveRelationship.moveFieldToObject
** Type: string
** Description: return data after moveFieldToObject
* moveRelationship.movedFields
** Type: object
** Description: return data field of moveToObject
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String
=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
moveNodeProperties: {
sourceObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: {
identifiers: { },
fields: { }
}
},
moveFieldToObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: { },
fields: {

}
},
movedFields: { Fields: { } } //
}
}
},
requestParam: { },
status: 'complete',
errorsFound: [],
graphServiceTag: 'GraphHandler'
}
</syntaxhighlight>
[[Category:Working documents| 2025-03-06]]

2025-03-06 - Graph Handler Docs

2026-06-03T05:18:59Z

Seagame: /* Request Example */

= GraphHandler Function =
== CreateNode ==
'''Use Case of CreateNode''' >>> https://izara.io/wiki/index.php/2025-03-27_Graph_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
* setFieldConditionals
** type : array
** Required : optional
* deepPathConditional
** type : array
** Required : optional
* parentFlowId
** type : string
** Required: true
* callingFlowConfig
** Type: object
** Required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType": {
"objectType": string,
"serviceTag": string
},
"objInstanceFull": {
"identifiers": {
// ...identifier
},
"fields": {
// ...fields
}
},
setFieldConditionals: [ // optional default array
{
objType: { },
indexValue: { nameSpace: 'ex-011', systemTextTag: 'Gate-011' }, // index field : value
fieldName: '', // fieldName want to set
passValue: 'false', optional
notPassValue: 'true', //optional
conditionals: [ optional ] // condition check field
}
],
"relationships": [
{
"relType": {
"serviceTag": string,
"relationshipTag": string
},
"relationshipProperties": {
//... key and value of targetIdentifiers
},
"relationshipDirection": string, // "from" | "to"
"targetObjType": {
"serviceTag": string,
"objectType": string
},
"targetIdentifiers": {
//... targetIdentifiers
}
}
],
deepPathConditional: [ // optional default array
{
condition: 'notExist', //
conditionCheck: { // traversal
nodeStructure: {
objType: { },
fields: { }
},
nextPath: {
relationshipStructure: {
relType: { },
relationshipDirection: 'to'
},
nodeStructure: {
objType: { },
fields: { }
}
}
}
}
],
"originTimestamp": number, // timestamp when create
"settings": {
"updatePropertiesOnMatch": boolean // default=false
},
"parentFlowId": "",
"callingFlow": string,
"callingFlowProperties": object,
}
</syntaxhighlight>

=== 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.relationships
** Type: array
** Description: data from relationships in targetNode
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* Status
** Type: string
** Description: Status from create node. Return "error" or "complete".
* errorsFound
** Type: array
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">

{
returnValue: {
queryResult: {
returnCreateNode: {
objTypes: [
{
serviceTag: "string",
objectType: "string"
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//...fields
}
},
existsNode: { },
userNode: { // // if has userNode send to createNode
objTypes: [
{
"serviceTag": "UserAccount",
"objectType": "user"
}
],
properties: {
//...properties
}
},
relationships: [ // optional : if has requiredOnCreated , createNode with targetNode
{
objTypes: [
{ serviceTag: 'string', objectType: 'string' }
],
objInstanceFull: {
identifiers: {
// identifiers
}
},
relType: {
serviceTag: 'string',
relationshipTag: 'rel'
},
relationshipProperties: {
// properties
}
},
]
}
},
requestParams: {
// return example send param
}
},
status: "string", // "complete' or "error"
errorsFound: [],
graphServiceTag: "GraphHandler"
}

</syntaxhighlight>

== GetNode ==
'''Use Case of GetNode''' >>> https://izara.io/wiki/index.php/2025-04-23_Graph_Use_Case/GetNode_and_GetNodes#Use_Case_GetNodes
=== 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
* versionedDataLabels
** Type: Array
** Required : optional
* settings.updatePropertiesOnMatch
** Type: Boolean
** Required : optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":string,
"objectType":string
},
"objInstanceFull":{
"identifiers":{
// ...identifier
},
"fields":{
// ...fields
}
},
"versionedDataLabels":[
//…versionedData
],
"settings": {
"returnSystemFieldsName" :boolean // default = true or false
}
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* returnValue.queryResult
** Type: object
* queryResult.refactoredNodes
** Type: object
** Description: return object from getNode
* refactoredNodes.objTypes
** Type: array
* refactoredNodes.objInstanceFull
** Type: object
* refactoredNodes.objInstanceFull.identifiers
** Type: object
* refactoredNodes.objInstanceFull.fields
** Type: object
* refactoredNodes.versionDataSystemFields
** Type: object
* refactoredNodes.versionDataSystemFields.versionedDataLabel
** Type: object
* queryResult.requestParam
** Type: object
** Description: return example send param
* errorsFound
** Type: string
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
refactoredNodes: {
objTypes: [
{
serviceTag: "string",
objectType: "string",
}
],
objInstanceFull: {
identifiers: {
//… identifier
},
fields: {
//…fields
}
},
versionDataSystemFields: {
versionedDataLabel: {
originTimestamp: number,
forMatchedId: "string",
versionedDataId: "string"
}
}
}
},
requestParam: {
// return example send param
}
},
errorsFound: [],
graphServiceTag: ''
}
</syntaxhighlight>

== GetNodes ==
'''Use Case of GetNodes''' >>> https://izara.io/wiki/index.php/2025-04-23_Graph_Use_Case/GetNode_and_GetNodes#Use_Case_GetNodes
=== Request Parameters ===
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* fields
** Type : object
** Required: true
* versionedDataLabels
** Type: Array
** Required : optional
* settings.returnSystemFieldsName
** Type: Boolean
** Required : optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":string,
"objectType":string
},
"fields":{
//…fields with matching value
},
"versionedDataLabels":[
//…versionedDataLabels
],
"settings":{
"returnSystemFieldsName":boolean // default=false
}
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResults
** Type: object
* queryResults.getNodesReturnValues
** Type: array
* getNodesReturnValues.objTypes
** Type: array
* getNodesReturnValues.objInstanceFull
** Type: object
* getNodesReturnValues.objInstanceFull.identifiers
** Type: object
* getNodesReturnValues.objInstanceFull.fields
** Type: object
* getNodesReturnValues.versionDataSystemFields
** Type: object
* getNodesReturnValues.versionDataSystemFields.versionedDataLabel
** Type: object
* requestParams
** Type: object
* errorsFound
** Type: string
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: {
getNodesReturnValues: [
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//.. all fields-1
}
},
versionDataSystemFields: {}
},
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//...all fields-2
}
},
versionDataSystemFields: {
versionedDataLabel: {
originTimestamp: number,
forMatchedId: 'string',
versionedDataId: 'string'
}
}
}
]
},
requestParams: {
// return example send param
}
}
}
</syntaxhighlight>

== UpdateNode ==
''' Use Case of UpdateNode''' >>> https://izara.io/wiki/index.php/2025-08-03_-_Graph_Use_Case/UpdateNode
=== 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: object
** Required : true
* objInstanceFull.fields
** Type : object
** Required: true
** Description : can not send fields to update mainNode and versionedData together
* versionedDataIds
** Type: object
** Required: optional
* originTimestamp
** Type: number
** Required: true
* settings
** Type: object
** Required: optional
* callingFlow
** Type: string
** Required: optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType": {
"serviceTag": string,
"objectType": string
},
"objInstanceFull": {
"identifiers": {
//…identifiers
},
"fields": {
//…fields
// can not be send fields of mainNode and versionedData in fields together!
}
},
"versionedDataIds": {},
"originTimestamp": number, //// timestamp when update
"settings": {},
"callingFlow": string
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* returnValue.queryResult
** Type: object
** Description: data from created node
* queryResult.objTypes
** Type: array
** Description: serviceTag and objectType
* queryResult.objInstanceFull
** Type: object
** Description: identifiers and fields
* queryResult.userId
** Type: object
** Description: data that update from user Account
* queryResult.versionDataSystemFields
** Type: object
** Description: optional return versionedData
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* returnValue.Status
** Type: string
** Description: status from updated node // error or complete
* returnValue.errorsFound
** Type: array
* returnValue.graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifiers
},
fields: {
//...fields
}
},
userId: {
// if have userNode send to updated
},
versionDataSystemFields: {
versionedDataLabel: {
}
}
},
requestParams: {
// return example send param
}
},
status: 'string',//"complete" // "error"
errorsFound: [],
graphServiceTag: 'string'
}
</syntaxhighlight>

== CreateRelationship ==
''' Use Case of CreateRelationship''' >>> https://izara.io/wiki/index.php/2025-08-01_-_Graph_Use_Case/CreateRelationship
=== Request Parameters ===
* firstObject
** Type: object
** Required: true
* secondObject
** Type: object
** Required: true
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* identifiers
** Type: object
** Required : true
* createRelationshipIfNothave
** Type : array
** Required: optional
** Description : using createRelationshipIfNothave for check relationship if not has created , can check both firstNode and SeconNode or onCreateAddRelationships
* onCreateAddRelationships
** Type: array of object
** Required: optional
* relType
** Type: object
** Required: true
* relationshipDirection
** Type: string
** Required: true
* relationshipProperties
** Type: object
** Required: true
* Settings
** Type: object
** Required: true
* settings.updateRelPropsWhenExist
** Type: boolean
** Required: optional
* callingFlow
** Type: string
** Required: optional
* callingFlowConfig
** Type: object
** Required: optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject": {
"objType": {
"serviceTag": string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"createRelationshipIfNothave": [ // optional
{
"onMatchRelationship": {
"relType": {
"serviceTag": string,
"relationshipTag": string
},
"relationshipProperties": {},
"relationshipDirection": string
},
"onMatchNode": {
"objType": {
"serviceTag":string,
"objectType": string
},
"fields": {
}
}
}
],
"onCreateAddRelationships": [
{
"objType": {
"serviceTag":string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"relType": {
"serviceTag":string,
"relationshipTag":string
},
"relationshipProperties": {
//…properties
},
"relationshipDirection":string // “from” , “to”
}
]
},
"secondObject": {
"objType": {
"serviceTag":string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"onCreateAddRelationships": [
//…optional
]
},
"relType": {
"serviceTag":string,
"relationshipTag":string
},
"relationshipDirection":string, // “from” , “to”
"relationshipProperties": {
//…properties
},
"settings": {
"updateRelPropsWhenExist": boolean,
},
"callingFlow": "xxxx",
"callingFlowProperties": {
"graphServiceName": string
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.relationship
** Type: object
* queryResult.relationship.relType
** Type: object
* queryResult.relationship.relationshipProperties
** Type: object
* queryResult.firstNode
** Type: object
** Description: return data structure from firstNode
* queryResult.secondNode
** Type: object
** Description: return data structure from secondNode
* queryResult..onCreateAddRelationships
** Type: array
** Description: return data structure from onCreateAddRelationships
* returnValue.firstObject
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* Status
** Type: string
** Description: status from create node // error or complete
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
relationship: {
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//…properties
}
},
firstNode: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: { //… identifiers },
fields: {
//… all fields
}
},
onCreateAddRelationships: [
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//… identifiers
},
fields: {
//… all fields
}
},
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//… all properties
}
}
]
},
secondNode: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: { //… identifiers },
fields: {
//… all fields
}
},
onCreateAddRelationships: [
//… optional
]
}
}
}
}
requestParams: {
// return example send param

},
Status: 'string', //“complete” // “error”
errorsFound: []
}
}
</syntaxhighlight>

== GetRelationship ==
=== Request Parameters ===
* firstObject
** Type: object
** Required: optional
* secondObject
** Type: object
** Required: optional
* objType
** Type: object
** Required: true
** Description: has serviceTag and objectType
* identifiers
** Type: object
** Required: true
* relType
** Type: object
** Required: true
** Description: has relationshipTag and serviceTag
* relId
** Type: string
** Required: true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag":string,
"objectType":string
},
"identifiers":{
//…identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"relType":{ // required
"relationshipTag": string,
"serviceTag": string
},
"relId": 'string' // // required
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
* Type: object
* queryResult.relType
** Type: object
* queryResult.relationshipProperties
** Type: object
** Description: return relId and properties
* returnValue.toObject
** Type: object
** Description: return toObject if not send secondObject from param
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* errorsFound
** Type: array
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: {
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//…properties : 'string’
}
},
toObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: {
identifiers: {
//
},
fields: { }
}
},
requestParams: {
// return example send param
}
}
}

</syntaxhighlight>

== UpdateRelationship ==
=== Request Parameters ===
* firstObject
** Type: object
** Required: optional
* secondObject
** Type: object
** Required: Optional
* objType
** Type: object
** Required: true
** Description: has serviceTag and objectType
* identifiers
** Type: object
** Required: true
* relId
** Type: string
** Required: true
* relType
** Type: object
** Required: true
** Description: has relationshipTag and serviceTag
* relationshipProperties
** Type: object
** Required: true
** Description: send properties that want to update
* relationshipDirection
** Type: string
** Required: optional
* callingFlow
** Type: string
** Required: optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"relId": string,
"relType":{
"serviceTag":string,
"relationshipTag":string
},
"relationshipProperties":{
//… properties that want to update
},
"relationshipDirection": string, // "from" // “to”
"callingFlow": string
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.firstObject And secondObject
** Type: object
** Description : return objType {seviceTag and objectType} And identifiers
* queryResult.relId
** Type: string
* queryResult.relType
** Type: object
** Description: return {seviceTag and relationshipTag}
* queryResult.relationshipDirection
** Type: string
* queryResult.updatePropertiesParam
** Type: object
** Description: return properties to updated
* queryResult.oldRelationshipProperties
** Type: object
** Description: return old properties before update
* queryResult.newRelationshipProperties
** Type: object
** Description: return new properties after updated
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type : string
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
firstObject: {
objType: {
serviceTag: "string",
objectType: "string"
},
identifiers: {
//…identifiers
}
},
secondObject: {
objType: {
serviceTag: "string",
objectType: "string"
},
identifiers: {
//…identifiers
}
},
relId: "string",
relType: {
serviceTag: "string",
relationshipTag: "string"
},
relationshipDirection: "string",
updatePropertiesParam: {
//… properties updated
},
oldRelationshipProperties: {
// … old properties before update
},
newRelationshipProperties: {
//… new properties after updated
}
}
},
requestParams: {
// return example send param
}
status: “string”, // "complete",”error”
errorsFound: []
}
</syntaxhighlight>

== GetNodeAndRelationship ==
=== Request Parameters ===
* sourceObjType
** Required: true
** Description: has serviceTag and objectType
* sourceIdentifiers
** Type: object
** Required: true
* sourceVersionedDataLabels
** Type: object
** Required: optional
* targetRelationships
** Type: Array
** Required: true
* relTypeAndDirection
** Type: object
** Required: true
* relTypeAndDirection.relType
** Type: object
** Required: true
** Description: has serviceTag and relationshipTag
* relTypeAndDirection.relationshipProperties
** Type: object
** Required: optional
* relTypeAndDirection.relationshipDirection
** Type: String
** Required: optional
* targetObjects
** Type: Array
** Required: Optional
* targetObjects.objType
** Type: object
** Required: required if send targetObjects in param
* targetObjects.identifiers
** Type: object
** Required: optional should have objType if identifiers exists
* targetObjects.versionedDataLabels
** Type: object
** Required: optional have objType if versionedDataLabels exists

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"sourceObjType": { // required
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"sourceIdentifiers": {}, // required
"sourceVersionedDataLabels": [], // optional
"targetRelationships": [ //required
{
"relTypeAndDirection": { // required
"relType": {
"serviceTag": "xxxx",
"relationshipTag": "rel"
},
"relationshipProperties": {},//optional
"relationshipDirection": "" // required
},
"targetObjects": [ // optional
{
"objType": {
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"identifiers": {}, // optional
"versionedDataLabels": [] // optional have objType if versionedDataLabels exists
}
]
},
// if have multiple relTypeAndDirection
],
"settings": {} // defaulf = false >>> if have versionedDataLabels want to return all field of versionedata: settings = { returnSystemFieldsName: true }
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.objTypes
** Type: array of object
** Description: return {serviceTag and objectType}
* queryResult.objInstanceFull
** Type: object
** Description: return {identifiers and fields}
* queryResult.relNodes:
** Type: array
* relNodes.relType
** Type: object
** Description: return {serviceTag and relationshipTag}
* relNodes.relationshipProperties
** Type: object
* relNodes.objTypes
** Type: array of object
** Description: return {serviceTag and objectType}
* relNodes.objInstanceFull
** Type: object
** Description: return {identifiers and fields}
* requestParams
** Type: object
** Description: return same requestParams
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: {},
fields: { }
},
relNodes: [
{
relType: {
serviceTag: 'xxxx',
relationshipTag: 'rel'
},
relationshipProperties: { },
objTypes: [
{
serviceTag: 'xxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: {},
fields: {
// field
}
},
versionDataSystemFields: {
'0VersionDataLabel': {
originTimestamp:
forMatchedId:
versionedDataId:
}
}
}
]
}
},
requestParam : {
// return example send param
},
errorsFound: [],
graphServiceTag: "GraphHandler"
}

</syntaxhighlight>

== ChangeRelationshipType ==
=== Request Parameters ===
* firstObject
** Type : object
** Required : true
* secondObject
** Type : object
** Required : true
* objType
** Type : object
** Required : true
* Identifiers
** Type : object
** Required : true
* oldRelTypeAndDirection
** Type : object
** Required : true
* oldRelTypeAndDirection.relType
** Type : object
** Required : true
* oldRelTypeAndDirection.relationshipDirection
** Type : string
** Required : true
* oldRelTypeAndDirection.relationshipProperties
** Type : object
** Required : optional
* newRelType
** Type : object
** Required : true
* originTimestamp
** Type : number
** Required : true
* changedByUserId
** Type : String
** Required : true
* callingFlow
** Type : String
** Required : optional
* settings
** Type : object
** Required : optional
** Description : default > settings.changeMultipleRelationships : false // if send settings.changeMultipleRelationships : true >> can change multiple relType

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"secondObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"oldRelTypeAndDirection":{
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"old"
},
"relationshipDirection":"from",
"relationshipProperties":{
//Properties
}
},
"newRelType":{
"serviceTag":"xxxx",
"relationshipTag":"new"
},
"originTimestamp":1234567890,
"changedByUserId":"xxxx",
"callingFlow":"yyyy",
"settings":{
"changeMultipleRelationships": boolean: // default false
}
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.newRelationshipType
** Type: object
* newRelationshipType.relType
** Type: object
* newRelationshipType.relationshipDirection
** Type: string
* newRelationshipType.relationshipProperties
** Type: object
* queryResult.oldRelationshipType
** Type: object
* oldRelationshipType.relType
** Type: object
* oldRelationshipType.relationshipDirection
** Type: string
* oldRelationshipType.relationshipProperties
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
newRelationshipType: {
relType: {
serviceTag: "xxxx",
relationshipTag: "new"
},
relationshipDirection: "" // 'from' or 'to'
relationshipProperties: {}
},
oldRelationshipType: {
relType: {
serviceTag: "xxxx",
relationshipTag: "old"
},
relationshipDirection: "" // 'from' or 'to'
relationshipProperties: {}
}
},
requestParams : {
// return example send param
}
},
status: "complete" // or error,
errorsFound: [],
graphServiceTag : 'GraphHandeler'
}

</syntaxhighlight>

== DeleteRelationship ==
=== Request Parameters ===
* fromObject
** Type : object
** Required : optional
* secondObject
** Type : object
** Required : optional
* objType
** Type : object
** Required : true
* Identifiers
** Type : object
** Required : true
* relType
** Type : object
** Required : true
* relId
** Type: string
** Required : true
* relationshipDirection
** Type: string
** Required : optional
* callingFlow
** Type: string
** Required : true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"yyyy"
},
"relId":"string"
},
"relationshipDirection":"string"// "from" or "to"
"callingFlow":"string"
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.objects
** Type: array
* queryResult.objTypes
** Type: array
* queryResult.objInstanceFull.identifiers
** Type: object
* queryResult.objInstanceFull.fields
** Type: object
** Description: return data of fromObject and secondObject
* queryResult.userNode
** Type: object
** Description: return data of userNode
* queryResult.resultDeleteRel
** Type : string
** Description: return status Relationship Delete
* requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objects: [
{
objTypes: [
{
serviceTag: "xxxx",
objectType: "yyyy"
}
],
objInstanceFull: {
identifiers: {
// identifiers
},
fields: {
// fields
}
}
},
{
// if have multiple object objTypes
}
],
userNode: {
objTypes: [
{
serviceTag: "UserAccount",
objectType: "user"
}
],
objInstanceFull: {
identifiers: {
userId: "zzz"
}
}
},
resultDeleteRel: "Relationship Deleted" // default
},
requeatParam: {
// return example send param
},
status: "string", //default "complete" or "error"
errorsFound: []
}
}

</syntaxhighlight>

== DeleteNode ==
=== Request Parameters ===
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* identifiers
** Type : object
** Required: true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":"xxx",
"objectType":"yyy"
},
"identifiers":{
//
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResults
** Type: object
* queryResults.resultDeleteNode
** Type: Boolean
** Description: return status deleted node >> true or false
* requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
** Description: return status deleted node >> complete or error
* errorsFound
** Type: array
* graphServiceTag
** Type: string
=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: { resultDeleteNode: true }, // true or false
requestParams: {
// return example send param
}
},
status: 'string', // 'complete' or 'error'
errorsFound: [],
graphServiceTag: 'GraphHandler'
}
</syntaxhighlight>

== MoveRelationship ==

=== Request Parameters ===
* sourceObject
** Type : object
** Required : true
** Description: required objType: {serviceTag , objectType} and identifiers
* targetObjType
** Type : object
** Required : true
** Description: required objType: {serviceTag , objectType}
* relType
** Type : object
** Required : true
** Description: required objType: {serviceTag , relationshipTag}
* relationshipDirection
** Type : object
** Required : true
* moveToIdentifiers
** Type : object
** Required : true
* moveByUserId
** Type : String
** Required : true
* originTimestamp
** Type : number
** Required : true
* settings
** Type : object
** Required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"sourceObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyy"
},
"identifiers":{
// identifiers
}
},
"targetObjType":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
}
},
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"rel"
},
"relationshipDirection":"from", // "to"
"moveToIdentifiers":{
// target identifiers
},
"moveByUserId":"xxxx",
"originTimestamp":1234567890,
"settings":{}
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.moveRelationship
** Type: object
* moveRelationship.sourceObject
** Type: object
** Description: return data of sourceObject
* moveRelationship.relationship
** Type: string
** Description: return data of after move relationship
* moveRelationship.moveToObject
** Type: object
** Description: return data of moveToObject
* moveRelationship.historyData
** Type: object
** Description: return properties {old target identifiers and originTimestamp} after moveRelationship
* moveRelationship.userNode
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
moveRelationship: {
sourceObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
}
},
relationship: {
relType: {
serviceTag: 'xxxx',
relationshipTag: 'rel'
},
relationshipProperties: { originTimestamp: 1234567890 }
},
moveToObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: { }
},
historyData: {
relationshipProperties: { }
},
userNode: {
objTypes: [{ serviceTag: 'UserAccount', objectType: 'user' }],
objInstanceFull: { }
}
}
},
requestParam: {
}
}
status: "complete" // or error,
errorsFound: [],
graphServiceTag: 'GraphHandler'
}

</syntaxhighlight>

== MoveNodeProperties ==
=== Request Parameters ===
* sourceObject
** type: object
** required : true
* targetIdentifiers
** type : object
** required : true
* moveProperties
** type : array
** required : true // index minimum = 1
* updateProperties
** type : object
** required : true
* movePropertiesConditions
** type : array
** required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
sourceObject: {
objType: { },
identifier: { }
},
targetIdentifiers: { },
moveProperties: [ ],
updateProperties: { },
movePropertiesConditions: [ // optional
{
checkObject: 'target', // "source" | "target"
onSetObject: 'target', // "source" | "target"
onPassValue: true,
onNotPassCondition: false, // optional
fieldNameConditions: [ ]
}
]
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.moveNodeProperties
** Type: object
* moveNodeProperties.sourceObject
** Type: object
** Description: return data of sourceObject
* moveRelationship.moveFieldToObject
** Type: string
** Description: return data after moveFieldToObject
* moveRelationship.movedFields
** Type: object
** Description: return data field of moveToObject
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String
=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
moveNodeProperties: {
sourceObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: {
identifiers: { },
fields: { }
}
},
moveFieldToObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: { },
fields: {

}
},
movedFields: { Fields: { } } //
}
}
},
requestParam: { },
status: 'complete',
errorsFound: [],
graphServiceTag: 'GraphHandler'
}
</syntaxhighlight>
[[Category:Working documents| 2025-03-06]]

2025-03-06 - Graph Handler Docs

2026-06-03T05:18:13Z

Seagame: /* Request Parameters */

= GraphHandler Function =
== CreateNode ==
'''Use Case of CreateNode''' >>> https://izara.io/wiki/index.php/2025-03-27_Graph_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
* setFieldConditionals
** type : array
** Required : optional
* deepPathConditional
** type : array
** Required : optional
* parentFlowId
** type : string
** Required: true
* callingFlowConfig
** Type: object
** Required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType": {
"objectType": string,
"serviceTag": string
},
"objInstanceFull": {
"identifiers": {
// ...identifier
},
"fields": {
// ...fields
}
},
setFieldConditionals: [ // optional default array
{
objType: { },
indexValue: { nameSpace: 'ex-011', systemTextTag: 'Gate-011' }, // index field : value
fieldName: '', // fieldName want to set
passValue: 'false', optional
notPassValue: 'true', //optional
conditionals: [ optional ] // condition check field
}
],
"relationships": [
{
"relType": {
"serviceTag": string,
"relationshipTag": string
},
"relationshipProperties": {
//... key and value of targetIdentifiers
},
"relationshipDirection": string, // "from" | "to"
"targetObjType": {
"serviceTag": string,
"objectType": string
},
"targetIdentifiers": {
//... targetIdentifiers
}
}
],
deepPathConditional: [ // optional default array
{
condition: 'notExist', //
conditionCheck: { // traversal
nodeStructure: {
objType: { },
fields: { }
},
nextPath: {
relationshipStructure: {
relType: { },
relationshipDirection: 'to'
},
nodeStructure: {
objType: { },
fields: { }
}
}
}
}
],
"originTimestamp": number, // timestamp when create
"settings": {
"updatePropertiesOnMatch": boolean // default=false
},
"callingFlow": string,
"callingFlowProperties": object,
}
</syntaxhighlight>

=== 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.relationships
** Type: array
** Description: data from relationships in targetNode
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* Status
** Type: string
** Description: Status from create node. Return "error" or "complete".
* errorsFound
** Type: array
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">

{
returnValue: {
queryResult: {
returnCreateNode: {
objTypes: [
{
serviceTag: "string",
objectType: "string"
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//...fields
}
},
existsNode: { },
userNode: { // // if has userNode send to createNode
objTypes: [
{
"serviceTag": "UserAccount",
"objectType": "user"
}
],
properties: {
//...properties
}
},
relationships: [ // optional : if has requiredOnCreated , createNode with targetNode
{
objTypes: [
{ serviceTag: 'string', objectType: 'string' }
],
objInstanceFull: {
identifiers: {
// identifiers
}
},
relType: {
serviceTag: 'string',
relationshipTag: 'rel'
},
relationshipProperties: {
// properties
}
},
]
}
},
requestParams: {
// return example send param
}
},
status: "string", // "complete' or "error"
errorsFound: [],
graphServiceTag: "GraphHandler"
}

</syntaxhighlight>

== GetNode ==
'''Use Case of GetNode''' >>> https://izara.io/wiki/index.php/2025-04-23_Graph_Use_Case/GetNode_and_GetNodes#Use_Case_GetNodes
=== 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
* versionedDataLabels
** Type: Array
** Required : optional
* settings.updatePropertiesOnMatch
** Type: Boolean
** Required : optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":string,
"objectType":string
},
"objInstanceFull":{
"identifiers":{
// ...identifier
},
"fields":{
// ...fields
}
},
"versionedDataLabels":[
//…versionedData
],
"settings": {
"returnSystemFieldsName" :boolean // default = true or false
}
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* returnValue.queryResult
** Type: object
* queryResult.refactoredNodes
** Type: object
** Description: return object from getNode
* refactoredNodes.objTypes
** Type: array
* refactoredNodes.objInstanceFull
** Type: object
* refactoredNodes.objInstanceFull.identifiers
** Type: object
* refactoredNodes.objInstanceFull.fields
** Type: object
* refactoredNodes.versionDataSystemFields
** Type: object
* refactoredNodes.versionDataSystemFields.versionedDataLabel
** Type: object
* queryResult.requestParam
** Type: object
** Description: return example send param
* errorsFound
** Type: string
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
refactoredNodes: {
objTypes: [
{
serviceTag: "string",
objectType: "string",
}
],
objInstanceFull: {
identifiers: {
//… identifier
},
fields: {
//…fields
}
},
versionDataSystemFields: {
versionedDataLabel: {
originTimestamp: number,
forMatchedId: "string",
versionedDataId: "string"
}
}
}
},
requestParam: {
// return example send param
}
},
errorsFound: [],
graphServiceTag: ''
}
</syntaxhighlight>

== GetNodes ==
'''Use Case of GetNodes''' >>> https://izara.io/wiki/index.php/2025-04-23_Graph_Use_Case/GetNode_and_GetNodes#Use_Case_GetNodes
=== Request Parameters ===
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* fields
** Type : object
** Required: true
* versionedDataLabels
** Type: Array
** Required : optional
* settings.returnSystemFieldsName
** Type: Boolean
** Required : optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":string,
"objectType":string
},
"fields":{
//…fields with matching value
},
"versionedDataLabels":[
//…versionedDataLabels
],
"settings":{
"returnSystemFieldsName":boolean // default=false
}
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResults
** Type: object
* queryResults.getNodesReturnValues
** Type: array
* getNodesReturnValues.objTypes
** Type: array
* getNodesReturnValues.objInstanceFull
** Type: object
* getNodesReturnValues.objInstanceFull.identifiers
** Type: object
* getNodesReturnValues.objInstanceFull.fields
** Type: object
* getNodesReturnValues.versionDataSystemFields
** Type: object
* getNodesReturnValues.versionDataSystemFields.versionedDataLabel
** Type: object
* requestParams
** Type: object
* errorsFound
** Type: string
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: {
getNodesReturnValues: [
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//.. all fields-1
}
},
versionDataSystemFields: {}
},
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//...all fields-2
}
},
versionDataSystemFields: {
versionedDataLabel: {
originTimestamp: number,
forMatchedId: 'string',
versionedDataId: 'string'
}
}
}
]
},
requestParams: {
// return example send param
}
}
}
</syntaxhighlight>

== UpdateNode ==
''' Use Case of UpdateNode''' >>> https://izara.io/wiki/index.php/2025-08-03_-_Graph_Use_Case/UpdateNode
=== 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: object
** Required : true
* objInstanceFull.fields
** Type : object
** Required: true
** Description : can not send fields to update mainNode and versionedData together
* versionedDataIds
** Type: object
** Required: optional
* originTimestamp
** Type: number
** Required: true
* settings
** Type: object
** Required: optional
* callingFlow
** Type: string
** Required: optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType": {
"serviceTag": string,
"objectType": string
},
"objInstanceFull": {
"identifiers": {
//…identifiers
},
"fields": {
//…fields
// can not be send fields of mainNode and versionedData in fields together!
}
},
"versionedDataIds": {},
"originTimestamp": number, //// timestamp when update
"settings": {},
"callingFlow": string
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* returnValue.queryResult
** Type: object
** Description: data from created node
* queryResult.objTypes
** Type: array
** Description: serviceTag and objectType
* queryResult.objInstanceFull
** Type: object
** Description: identifiers and fields
* queryResult.userId
** Type: object
** Description: data that update from user Account
* queryResult.versionDataSystemFields
** Type: object
** Description: optional return versionedData
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* returnValue.Status
** Type: string
** Description: status from updated node // error or complete
* returnValue.errorsFound
** Type: array
* returnValue.graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifiers
},
fields: {
//...fields
}
},
userId: {
// if have userNode send to updated
},
versionDataSystemFields: {
versionedDataLabel: {
}
}
},
requestParams: {
// return example send param
}
},
status: 'string',//"complete" // "error"
errorsFound: [],
graphServiceTag: 'string'
}
</syntaxhighlight>

== CreateRelationship ==
''' Use Case of CreateRelationship''' >>> https://izara.io/wiki/index.php/2025-08-01_-_Graph_Use_Case/CreateRelationship
=== Request Parameters ===
* firstObject
** Type: object
** Required: true
* secondObject
** Type: object
** Required: true
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* identifiers
** Type: object
** Required : true
* createRelationshipIfNothave
** Type : array
** Required: optional
** Description : using createRelationshipIfNothave for check relationship if not has created , can check both firstNode and SeconNode or onCreateAddRelationships
* onCreateAddRelationships
** Type: array of object
** Required: optional
* relType
** Type: object
** Required: true
* relationshipDirection
** Type: string
** Required: true
* relationshipProperties
** Type: object
** Required: true
* Settings
** Type: object
** Required: true
* settings.updateRelPropsWhenExist
** Type: boolean
** Required: optional
* callingFlow
** Type: string
** Required: optional
* callingFlowConfig
** Type: object
** Required: optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject": {
"objType": {
"serviceTag": string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"createRelationshipIfNothave": [ // optional
{
"onMatchRelationship": {
"relType": {
"serviceTag": string,
"relationshipTag": string
},
"relationshipProperties": {},
"relationshipDirection": string
},
"onMatchNode": {
"objType": {
"serviceTag":string,
"objectType": string
},
"fields": {
}
}
}
],
"onCreateAddRelationships": [
{
"objType": {
"serviceTag":string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"relType": {
"serviceTag":string,
"relationshipTag":string
},
"relationshipProperties": {
//…properties
},
"relationshipDirection":string // “from” , “to”
}
]
},
"secondObject": {
"objType": {
"serviceTag":string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"onCreateAddRelationships": [
//…optional
]
},
"relType": {
"serviceTag":string,
"relationshipTag":string
},
"relationshipDirection":string, // “from” , “to”
"relationshipProperties": {
//…properties
},
"settings": {
"updateRelPropsWhenExist": boolean,
},
"callingFlow": "xxxx",
"callingFlowProperties": {
"graphServiceName": string
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.relationship
** Type: object
* queryResult.relationship.relType
** Type: object
* queryResult.relationship.relationshipProperties
** Type: object
* queryResult.firstNode
** Type: object
** Description: return data structure from firstNode
* queryResult.secondNode
** Type: object
** Description: return data structure from secondNode
* queryResult..onCreateAddRelationships
** Type: array
** Description: return data structure from onCreateAddRelationships
* returnValue.firstObject
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* Status
** Type: string
** Description: status from create node // error or complete
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
relationship: {
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//…properties
}
},
firstNode: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: { //… identifiers },
fields: {
//… all fields
}
},
onCreateAddRelationships: [
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//… identifiers
},
fields: {
//… all fields
}
},
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//… all properties
}
}
]
},
secondNode: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: { //… identifiers },
fields: {
//… all fields
}
},
onCreateAddRelationships: [
//… optional
]
}
}
}
}
requestParams: {
// return example send param

},
Status: 'string', //“complete” // “error”
errorsFound: []
}
}
</syntaxhighlight>

== GetRelationship ==
=== Request Parameters ===
* firstObject
** Type: object
** Required: optional
* secondObject
** Type: object
** Required: optional
* objType
** Type: object
** Required: true
** Description: has serviceTag and objectType
* identifiers
** Type: object
** Required: true
* relType
** Type: object
** Required: true
** Description: has relationshipTag and serviceTag
* relId
** Type: string
** Required: true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag":string,
"objectType":string
},
"identifiers":{
//…identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"relType":{ // required
"relationshipTag": string,
"serviceTag": string
},
"relId": 'string' // // required
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
* Type: object
* queryResult.relType
** Type: object
* queryResult.relationshipProperties
** Type: object
** Description: return relId and properties
* returnValue.toObject
** Type: object
** Description: return toObject if not send secondObject from param
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* errorsFound
** Type: array
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: {
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//…properties : 'string’
}
},
toObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: {
identifiers: {
//
},
fields: { }
}
},
requestParams: {
// return example send param
}
}
}

</syntaxhighlight>

== UpdateRelationship ==
=== Request Parameters ===
* firstObject
** Type: object
** Required: optional
* secondObject
** Type: object
** Required: Optional
* objType
** Type: object
** Required: true
** Description: has serviceTag and objectType
* identifiers
** Type: object
** Required: true
* relId
** Type: string
** Required: true
* relType
** Type: object
** Required: true
** Description: has relationshipTag and serviceTag
* relationshipProperties
** Type: object
** Required: true
** Description: send properties that want to update
* relationshipDirection
** Type: string
** Required: optional
* callingFlow
** Type: string
** Required: optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"relId": string,
"relType":{
"serviceTag":string,
"relationshipTag":string
},
"relationshipProperties":{
//… properties that want to update
},
"relationshipDirection": string, // "from" // “to”
"callingFlow": string
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.firstObject And secondObject
** Type: object
** Description : return objType {seviceTag and objectType} And identifiers
* queryResult.relId
** Type: string
* queryResult.relType
** Type: object
** Description: return {seviceTag and relationshipTag}
* queryResult.relationshipDirection
** Type: string
* queryResult.updatePropertiesParam
** Type: object
** Description: return properties to updated
* queryResult.oldRelationshipProperties
** Type: object
** Description: return old properties before update
* queryResult.newRelationshipProperties
** Type: object
** Description: return new properties after updated
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type : string
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
firstObject: {
objType: {
serviceTag: "string",
objectType: "string"
},
identifiers: {
//…identifiers
}
},
secondObject: {
objType: {
serviceTag: "string",
objectType: "string"
},
identifiers: {
//…identifiers
}
},
relId: "string",
relType: {
serviceTag: "string",
relationshipTag: "string"
},
relationshipDirection: "string",
updatePropertiesParam: {
//… properties updated
},
oldRelationshipProperties: {
// … old properties before update
},
newRelationshipProperties: {
//… new properties after updated
}
}
},
requestParams: {
// return example send param
}
status: “string”, // "complete",”error”
errorsFound: []
}
</syntaxhighlight>

== GetNodeAndRelationship ==
=== Request Parameters ===
* sourceObjType
** Required: true
** Description: has serviceTag and objectType
* sourceIdentifiers
** Type: object
** Required: true
* sourceVersionedDataLabels
** Type: object
** Required: optional
* targetRelationships
** Type: Array
** Required: true
* relTypeAndDirection
** Type: object
** Required: true
* relTypeAndDirection.relType
** Type: object
** Required: true
** Description: has serviceTag and relationshipTag
* relTypeAndDirection.relationshipProperties
** Type: object
** Required: optional
* relTypeAndDirection.relationshipDirection
** Type: String
** Required: optional
* targetObjects
** Type: Array
** Required: Optional
* targetObjects.objType
** Type: object
** Required: required if send targetObjects in param
* targetObjects.identifiers
** Type: object
** Required: optional should have objType if identifiers exists
* targetObjects.versionedDataLabels
** Type: object
** Required: optional have objType if versionedDataLabels exists

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"sourceObjType": { // required
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"sourceIdentifiers": {}, // required
"sourceVersionedDataLabels": [], // optional
"targetRelationships": [ //required
{
"relTypeAndDirection": { // required
"relType": {
"serviceTag": "xxxx",
"relationshipTag": "rel"
},
"relationshipProperties": {},//optional
"relationshipDirection": "" // required
},
"targetObjects": [ // optional
{
"objType": {
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"identifiers": {}, // optional
"versionedDataLabels": [] // optional have objType if versionedDataLabels exists
}
]
},
// if have multiple relTypeAndDirection
],
"settings": {} // defaulf = false >>> if have versionedDataLabels want to return all field of versionedata: settings = { returnSystemFieldsName: true }
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.objTypes
** Type: array of object
** Description: return {serviceTag and objectType}
* queryResult.objInstanceFull
** Type: object
** Description: return {identifiers and fields}
* queryResult.relNodes:
** Type: array
* relNodes.relType
** Type: object
** Description: return {serviceTag and relationshipTag}
* relNodes.relationshipProperties
** Type: object
* relNodes.objTypes
** Type: array of object
** Description: return {serviceTag and objectType}
* relNodes.objInstanceFull
** Type: object
** Description: return {identifiers and fields}
* requestParams
** Type: object
** Description: return same requestParams
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: {},
fields: { }
},
relNodes: [
{
relType: {
serviceTag: 'xxxx',
relationshipTag: 'rel'
},
relationshipProperties: { },
objTypes: [
{
serviceTag: 'xxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: {},
fields: {
// field
}
},
versionDataSystemFields: {
'0VersionDataLabel': {
originTimestamp:
forMatchedId:
versionedDataId:
}
}
}
]
}
},
requestParam : {
// return example send param
},
errorsFound: [],
graphServiceTag: "GraphHandler"
}

</syntaxhighlight>

== ChangeRelationshipType ==
=== Request Parameters ===
* firstObject
** Type : object
** Required : true
* secondObject
** Type : object
** Required : true
* objType
** Type : object
** Required : true
* Identifiers
** Type : object
** Required : true
* oldRelTypeAndDirection
** Type : object
** Required : true
* oldRelTypeAndDirection.relType
** Type : object
** Required : true
* oldRelTypeAndDirection.relationshipDirection
** Type : string
** Required : true
* oldRelTypeAndDirection.relationshipProperties
** Type : object
** Required : optional
* newRelType
** Type : object
** Required : true
* originTimestamp
** Type : number
** Required : true
* changedByUserId
** Type : String
** Required : true
* callingFlow
** Type : String
** Required : optional
* settings
** Type : object
** Required : optional
** Description : default > settings.changeMultipleRelationships : false // if send settings.changeMultipleRelationships : true >> can change multiple relType

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"secondObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"oldRelTypeAndDirection":{
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"old"
},
"relationshipDirection":"from",
"relationshipProperties":{
//Properties
}
},
"newRelType":{
"serviceTag":"xxxx",
"relationshipTag":"new"
},
"originTimestamp":1234567890,
"changedByUserId":"xxxx",
"callingFlow":"yyyy",
"settings":{
"changeMultipleRelationships": boolean: // default false
}
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.newRelationshipType
** Type: object
* newRelationshipType.relType
** Type: object
* newRelationshipType.relationshipDirection
** Type: string
* newRelationshipType.relationshipProperties
** Type: object
* queryResult.oldRelationshipType
** Type: object
* oldRelationshipType.relType
** Type: object
* oldRelationshipType.relationshipDirection
** Type: string
* oldRelationshipType.relationshipProperties
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
newRelationshipType: {
relType: {
serviceTag: "xxxx",
relationshipTag: "new"
},
relationshipDirection: "" // 'from' or 'to'
relationshipProperties: {}
},
oldRelationshipType: {
relType: {
serviceTag: "xxxx",
relationshipTag: "old"
},
relationshipDirection: "" // 'from' or 'to'
relationshipProperties: {}
}
},
requestParams : {
// return example send param
}
},
status: "complete" // or error,
errorsFound: [],
graphServiceTag : 'GraphHandeler'
}

</syntaxhighlight>

== DeleteRelationship ==
=== Request Parameters ===
* fromObject
** Type : object
** Required : optional
* secondObject
** Type : object
** Required : optional
* objType
** Type : object
** Required : true
* Identifiers
** Type : object
** Required : true
* relType
** Type : object
** Required : true
* relId
** Type: string
** Required : true
* relationshipDirection
** Type: string
** Required : optional
* callingFlow
** Type: string
** Required : true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"yyyy"
},
"relId":"string"
},
"relationshipDirection":"string"// "from" or "to"
"callingFlow":"string"
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.objects
** Type: array
* queryResult.objTypes
** Type: array
* queryResult.objInstanceFull.identifiers
** Type: object
* queryResult.objInstanceFull.fields
** Type: object
** Description: return data of fromObject and secondObject
* queryResult.userNode
** Type: object
** Description: return data of userNode
* queryResult.resultDeleteRel
** Type : string
** Description: return status Relationship Delete
* requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objects: [
{
objTypes: [
{
serviceTag: "xxxx",
objectType: "yyyy"
}
],
objInstanceFull: {
identifiers: {
// identifiers
},
fields: {
// fields
}
}
},
{
// if have multiple object objTypes
}
],
userNode: {
objTypes: [
{
serviceTag: "UserAccount",
objectType: "user"
}
],
objInstanceFull: {
identifiers: {
userId: "zzz"
}
}
},
resultDeleteRel: "Relationship Deleted" // default
},
requeatParam: {
// return example send param
},
status: "string", //default "complete" or "error"
errorsFound: []
}
}

</syntaxhighlight>

== DeleteNode ==
=== Request Parameters ===
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* identifiers
** Type : object
** Required: true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":"xxx",
"objectType":"yyy"
},
"identifiers":{
//
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResults
** Type: object
* queryResults.resultDeleteNode
** Type: Boolean
** Description: return status deleted node >> true or false
* requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
** Description: return status deleted node >> complete or error
* errorsFound
** Type: array
* graphServiceTag
** Type: string
=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: { resultDeleteNode: true }, // true or false
requestParams: {
// return example send param
}
},
status: 'string', // 'complete' or 'error'
errorsFound: [],
graphServiceTag: 'GraphHandler'
}
</syntaxhighlight>

== MoveRelationship ==

=== Request Parameters ===
* sourceObject
** Type : object
** Required : true
** Description: required objType: {serviceTag , objectType} and identifiers
* targetObjType
** Type : object
** Required : true
** Description: required objType: {serviceTag , objectType}
* relType
** Type : object
** Required : true
** Description: required objType: {serviceTag , relationshipTag}
* relationshipDirection
** Type : object
** Required : true
* moveToIdentifiers
** Type : object
** Required : true
* moveByUserId
** Type : String
** Required : true
* originTimestamp
** Type : number
** Required : true
* settings
** Type : object
** Required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"sourceObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyy"
},
"identifiers":{
// identifiers
}
},
"targetObjType":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
}
},
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"rel"
},
"relationshipDirection":"from", // "to"
"moveToIdentifiers":{
// target identifiers
},
"moveByUserId":"xxxx",
"originTimestamp":1234567890,
"settings":{}
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.moveRelationship
** Type: object
* moveRelationship.sourceObject
** Type: object
** Description: return data of sourceObject
* moveRelationship.relationship
** Type: string
** Description: return data of after move relationship
* moveRelationship.moveToObject
** Type: object
** Description: return data of moveToObject
* moveRelationship.historyData
** Type: object
** Description: return properties {old target identifiers and originTimestamp} after moveRelationship
* moveRelationship.userNode
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
moveRelationship: {
sourceObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
}
},
relationship: {
relType: {
serviceTag: 'xxxx',
relationshipTag: 'rel'
},
relationshipProperties: { originTimestamp: 1234567890 }
},
moveToObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: { }
},
historyData: {
relationshipProperties: { }
},
userNode: {
objTypes: [{ serviceTag: 'UserAccount', objectType: 'user' }],
objInstanceFull: { }
}
}
},
requestParam: {
}
}
status: "complete" // or error,
errorsFound: [],
graphServiceTag: 'GraphHandler'
}

</syntaxhighlight>

== MoveNodeProperties ==
=== Request Parameters ===
* sourceObject
** type: object
** required : true
* targetIdentifiers
** type : object
** required : true
* moveProperties
** type : array
** required : true // index minimum = 1
* updateProperties
** type : object
** required : true
* movePropertiesConditions
** type : array
** required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
sourceObject: {
objType: { },
identifier: { }
},
targetIdentifiers: { },
moveProperties: [ ],
updateProperties: { },
movePropertiesConditions: [ // optional
{
checkObject: 'target', // "source" | "target"
onSetObject: 'target', // "source" | "target"
onPassValue: true,
onNotPassCondition: false, // optional
fieldNameConditions: [ ]
}
]
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.moveNodeProperties
** Type: object
* moveNodeProperties.sourceObject
** Type: object
** Description: return data of sourceObject
* moveRelationship.moveFieldToObject
** Type: string
** Description: return data after moveFieldToObject
* moveRelationship.movedFields
** Type: object
** Description: return data field of moveToObject
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String
=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
moveNodeProperties: {
sourceObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: {
identifiers: { },
fields: { }
}
},
moveFieldToObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: { },
fields: {

}
},
movedFields: { Fields: { } } //
}
}
},
requestParam: { },
status: 'complete',
errorsFound: [],
graphServiceTag: 'GraphHandler'
}
</syntaxhighlight>
[[Category:Working documents| 2025-03-06]]

Per Service Schemas

2026-05-28T03:56:03Z

Seagame: /* Not extendObjType */

= Overview =

Each service manages a schema of object/resources that it is responsible for, this schema is available to other services and frontends. The schema includes a list of fields available for each object.

= File Structure =

* see [[Repository structure#schemas|Repository structure]]

= ObjectSchema | ObjectFieldSchema.js =

== Not extendObjType ==

<syntaxhighlight lang="javascript">
{
objectType: "xx",
shortNameObjectType:"x", // optional, use when generate code create lambda role with long name
canDelete: false, // whether any fields can be deleted // default = false
belongTo: {
serviceTag:"iii",
objectType:"jjj"
},
// how is the object created
// userGenerated there will be generated endpoints for api or sqs (used in importBatchMain) to create object
// systemGenerated must be created by flow/s
// searchResultGenerated see separate notes below
generatedBy: "userGenerated" || "systemGenerated" || "searchResultGenerated" // required
searchResultGeneratedFlowType: {}, // for generatedBy = searchResultGenerated
addOnDataStructure: [ // optional, add for additional setting to objectType
{
// all fields that a user can edit must be in versionedData, and all fields in versionedData must be editable by user
type:"versionedData",
versionedDataLabel: "xx", // versionedData label name
storageResourceTag : "xx", // ref to storegeResourceTag
fieldNames: { // fieldName in versionedData cannot have in in main objectSchema.fieldNames
"aaa":{ // fieldName
type: "xx", // string|integer|number|timestamp|currency|currencyValue|float|special|object|boolean|arrayMixed|arrayNumeric|arrayString
requiredOnCreate: false, // default = false
optionalOnCreate: false, // default = false,
validation: {
itemValidation:{} // for validate item in array
},
// probably impossible to have fromObjType, because data can be changed by user here
fromObjType:{
serviceTag: "xxx",
objectType: "xxx"
},
},
// ...
}
},
{ // can have multiple addOn of type attributeTree
type:"attributeTree",
},
{
type:"translation"
},
{
type:"propertyValue"
},
{
type:"mediaLink"
},
{
type:"rbac"
},
// ...
],
plugInTags: ["a", "b"], // plugIns that can be connected to this objType
storageResources:{
"xxx":{ // storageResourceTag
storageType: "xx", // graph
graphServerTag: "xx", // setting for storageType graph
additionalGraphIndexes:[['fieldName1', 'fieldName2', ...], [...]] // will make graph index with specific fieldName
},
"zzz":{ // storageResourceTag
storageType: "xx", // dynamoDB
// setting for storageType dynamoDB
tableName: "xx",
groupByPartitionKeyField: "xx", // use groupByPartitionKeyField as partition key and not have sort key in dynamoDB, if have multiple identifiers will concat it. And use it as partitionKey.
serviceTag:"zz"// default own service.
}
},
fieldNames: {
xxx: { // fieldName
type: "xx", // string|integer|number|timestamp|currency|currencyValue|float|special|object|boolean|arrayMixed|arrayNumeric|arrayString
randomOnCreate: false, // default = false , can set true in fieldName that part of identifiers and identifiers have single identifierFieldname
requiredOnCreate: false, // default = false
optionalOnCreate: false, // default = false
canUpdate: true, // default = true (only system/flows can edit, no history of changes unless flow manually adds)
validation: {
itemValidation:{} // for validate item in array
}, // maybe ajv syntax
storageResourceTags: ["xx","yy"], // reference to storageResources property
fromObjType:{
serviceTag: "xxx",
objectType: "xxx"
},
hashOnCreate: ["xx", "yy"], // reference to other fieldName,
statusField: true, // use for objectSchema inside flowSchema, identify which field is statusField

// or
fromRequiredOnCreate: {
relType: {
serviceTag:"aa",
relationshipTag:"bb"
},
fieldName:"" // optional default= same field name eg: now default == xxx if not defined(use fieldname of object inside link when create)
}

},
// ...
},
compositeKeyDeliminator: "xx", // join partitionKey and sortKey
identifiers: [
// for dynamoDB storageType
{
type: "partitionKey",

fieldNames: ["xx","yy"], // composite partition keys in DynamoDB
deliminator: "xx", // optional, defaults to "_"
name: "zz", // name of field in database
// or
fieldName: "xx"

},
{
type: "sortKey",

fieldNames: ["xx","yy"], // composite partition keys in DynamoDB
deliminator: "xx", // optional, defaults to "_"
name: "zz", // name of field in database
// or
fieldName: "xx"

},

// for graph storageType
{
type: "identifier",
fieldNames: ["xx","yy"], // identifier field in graph or composite partition keys in DynamoDB
name: "zzz" // use when save in dynamoDB partitionKey
deliminator: "xx", // optional, defaults to "_"
// or
fieldName: "xx"
},
]
}
</syntaxhighlight>

== extendObjType ==

<syntaxhighlight lang="javascript">
{
// for objects stored in graph this will add another node label
objectType: "xx", // new label to add
extendObjType: { // core object that this object extends
serviceTag: "xxx",
objectType: "xxx"
},
addOnDataStructure: [],
storageResources:{ // these are the storageResources that carry the extended objects settings,
// (see above)
},
fieldNames: {
// (see above)
},
// canDelete/identifiers come from the core object
}
</syntaxhighlight>

== searchResultGenerated ==

* must be created by flow
* eg: variantProduct
* not have any storageResources
* identifiers are automatically searchResultData identifiers
* a searchResult request for this object will enter the searchResultGeneratedFlowType flow which creates searchResultData that can then be queried/sorted
* all relationships must be storageType = lambda, eg translate from variantProduct to variant uses a translateId flow to query the variantProduct identifier (searchResultData) to find the variantId in it's requiredData results
* searchResultGeneratedFlowType takes over after creating searchResultMain record until processRequiredData
* if objectSchema defines any fieldnames, then they are found using a flow, maybe as hooks in per service findData
* when finding direct fieldname, will need to check if requireData already exists, if not enter flow/findData to create
* no fields can be edited, so can show in forms but no updates performed

= Relationships Schema | ObjectRelationships.js =

* stored in top level schemas folder
* parent/child determines relationship direction for graph relationships
* have one service that contains information of each relationship

<syntaxhighlight lang="javascript">
// relationship schema in responsible service
[
{
"xxx": { // relationshipTag - name of relationship type stored in graph
generatedBy: "userGenerated" || "systemGenerated" // default="userGenerated"
canChangeToRelTypes: [
{
relType: { // relType that this relType can change to
serviceTag:"xxx",
relationshipTag: "yyy"
},
changeBy: "user" // "systemNoUserId" | "systemWithUserId" | "user", default="user"
}
// another relType
],
// moveBy allows the relationship to be moved between 2 instances of the same objType only
moveBy: "none" // "systemNoUserId" | "systemWithUserId" | "user" | "none", default="none"
storageResources:{
"xxx":{ // storageResourceTag
storageType: "xx", // dynamoDB | graph | lambda
// if storageType="dynamoDB" will not specify tableName in relationship schema

// setting for storageType graph
graphServerTag: "xx",
additionalGraphIndexes:[['fieldName1', 'fieldName2', ...], [...]], // will make graph index with specific fieldName

// setting for storageType lambda
serviceTag: "xx",
functionName: "xx",
}
},
fieldNames: {
"xxx": { // relationship property name
type: "string", // "string" | "number" ...
requiredOnCreate: false, // default=false
optionalOnCreate: false, // default = false
updateBy: "user" // "systemNoUserId" | "systemWithUserId" | "user" | "none", default="user"
validation: {} // ajv syntax
},
//...other relationship properties
},
links: [
{
storageResourceTags: ["xxx"], // reference from storageResources property
canDelete: false // default = false, if set true will allow delete relationship between 2 objType
from: {
objType: {
serviceTag: "xx",
objectType: "xx"
},
requiredOnCreate: true, // if set true will create relationshipTag when create objType data, if both "from" and "to" linkType="many" should not have requiredOnCreate, exists in "from" or "to" only
linkType: "", // one | many
},
to: {
objType: {
serviceTag: "yy",
objectType: "yy"
},
linkType: "", // one | many
},
requestProperties: {
// if storageType is Lambda and translateIds/linkPath requires properties set them here (eg sellOffer>orderPrice)
tag_deliverTo: {
requestPropertyType: "objectIdentifier",
objType: {
serviceTag: "Locations",
objectType: "locationNode" // deliversToLocationNode
},
identifiersFieldName: "locationNodeId"
},
// ... other request properties
}
}
// ...other link
]
}
}
]

</syntaxhighlight>

= Reference Relationships Schema | RefObjectRelationships.js =

<syntaxhighlight lang="javascript">
// reference to relationshipTag in external service
[
{
objectType: "zz", // objectType in local service
relationshipTag: "xxx", // name of relationshiptag of objType
relationshipServiceTag: "xx" // point to service tag that contain data of relationshipTag of objType
}
]

</syntaxhighlight>

= Flow Schema | FlowSchemas.js =

<syntaxhighlight lang="javascript">
[
{
flowTag: "yyy",
initiateBy:"user", // "user" | "system" -- if receive plugin should be user
handleObj:"one", // "one" | "multi"
statusType:"statusField", // "statusField" | "storedCache" | "none" | "triggerCache"

// statusType="triggerCache" setting
triggerType: "storedCache", // "storedCache" | "switch"
triggerFlowTypes:[
//... triggerFlowType
],

// statusType="statusField" | "triggerCache" | "storedCache" setting:
objType:{},

event:["ownTopic"], // "ownTopic" | "extTopic" | "s3" | "eventBridge" | "lambdaSyncInv" | "lambdaSyncApi" | "generatedCode"

// event="s3" setting
bucketName: "xxx", // bucket for s3 event
createBucket: boolean, // if true will generate new bucket with bucketName if false will point to old bucket that already have

// event="eventBridge" setting
schedules:[
{
name: 'your-scheduled-rate-event-name',
description: 'your scheduled rate event description',
rate: ["rate(1 minute)", ],
input:{}
}
],

// event="generatedCode" setting
generatedCodeConfig:{
generatedCodeTag: "create", // tag for generated code, eg "create" | "update" | "delete"
codeHookTag: "xx", // which codeHook to initiate flow from
// maybe validate: invocationType must exist in "event" array, so don't need to check 2 places when eg creating sns topic
invocationType: "ownTopic", // "ownTopic" | "lambdaSyncInv"

objType: {}, // which cases in the generated code trigger the flow
// .. other settings depending on generated code
}

outputTopic: boolean,

flowSteps:[
In:{ // will generate Topic serviceTag_stage_yyy_In
properties:[], // reference to stepProperties key
messageAttributes: [] // reference to stepProperties key
},
// another flow steps
flowStep1:{ // will generate Topic serviceTag_stage_yyy_Flow1
properties:[], // reference to stepProperties key
messageAttributes: [] // reference to stepProperties key
event:["ownTopic"], // "ownTopic" | "extTopic" | "s3" | "eventBridge" | "lambdaSyncInv" | "lambdaSyncApi" | "generatedCode"
// handle splitting logic into awaitingStep/awaitingMultipleSteps
// handle splitting logic into paginated lambda

plugInHooks: [
{
plugInHookTag: "",
objType:{}, // used to query connection dynamo for an object instance in current flow
},
]
},
Out:{ // will generate Topic serviceTag_stage_yyy_Out
properties:[], // reference to stepProperties key
messageAttributes: [] // reference to stepProperties key
},
]

stepProperties:{
"uuid":{
propertyName:"xxx",
type:"string",
},
"uuid2":{
objectField:{
objType:{},
fieldName:"xx"
},
overwritePropertyName:"xx" // optional, if have objectField and have overwritePropertyName will overwrite fieldName
}
},
}
]
</syntaxhighlight>

= System Text Schema | SystemTextSchemas.js =

<syntaxhighlight lang="javascript">
[
{
namespace: "xxx", // groups files downloaded by frontend
systemTextTag: "yyy",
}
]
</syntaxhighlight>

== Auto generated systemText and namespaces ==

=== systemNotification names ===

* namespace: "sysNotification_{notificationGrouping}"
* systemTextTag: "{notificationTag}"
* eg shown on notification settings page

=== objType names ===

* namespace: "objTypes"
* systemTextTag: "{serviceTag}_{objectType}"
* eg shown on config pages, eg pulldown list of object types

=== objType field name descriptions ===

* namespace: "objType_fielddesc_{serviceTag}_{objectType}"
* systemTextTag: "{fieldname}"
* eg shown on config pages, eg info box for each field name

= System Notification Schema | SystemNotificationSchemas.js =

<syntaxhighlight lang="javascript">
[
{
notificationTag: "xxx",
notificationGrouping: "yyy",
weight: "##",
},
]
</syntaxhighlight>

= Generated S3 files =

* generate multiple files for different uses, eg:
*# list of saved fieldNames for Create
*# list of saved+calculated for Update/Info pages
*# graphSchemas
*# relationships (used by Search/Sort Results)

= Use Cases =

== Find Deployed Service Name ==

* other services can use fixed serviceTag to get deployed serviceName from serviceSchema on S3
* used to build resource names for external services
* eg when one service needs to send a message into an SNS belonging to a different service

== Standard Create, Update, List, Delete pages ==

* List and Delete are maybe not required, use table data system instead.
* object schema can add validation information that can be used on the frontend to check before sending to backend, and by the backend to validate the data before handling

=== Create Object ===

* can configure what fields are shown
* requiredOnCreate fields must be shown

=== Edit Object ===

* users setup any number of pages for object types with configurable fields shown
* fields can be either display only or edit
* each field can adjust it's display properties (perhaps via cssStyles)

== Menu Config ==

When adding menu items can add links to create, update, list, delete objects, user chooses the service then from that service's list of objects and what action is being performed. For update/delete perhaps links to a standard page that asks for the identifier before presenting the page.

== Tabled Data ==

When viewing tabled data the frontend pulls the tableId's config from backend, then when requesting the data also requests the serviceTag > objectType schema for use when displaying the data.

== Code Standardization ==

Code such as middleware validation schema and saving data to databases can be standardized.

== Code Generation ==

Endpoints per object for actions such as Create/Delete/Update can be automatically generated from objectSchema.

=== Code Generation Structure ===

* npm for generic code generation, can be used in any project, includes functions for generating Source files from templates and developer files
* npm for per project specific files, eg templates for the project (Create/Update/.. code)
* Empty Service Template has GenerateCode.js script file in root dir that is run to generate code, it invokes a generation function from generic npm with param that points to per project npm's templates
* generated Source retains hook tags (and any developer added code), so if developer wants to update developer's file with updated template code they can generate code and simply copy generated Source to src folder

= Graph Server Config =

* S3 has a list of graphServerTag's linking to the GraphHandler serviceTag responsible for the graph
* multiple graphServerTags can point to one GraphHandler, combining graphs into one server
* when creating each GraphHandler's graph schemas, for each field split out the fields into each GraphHandler using the graphServerTag, if multiple graphServerTags for a field point to the same GraphHandler combine the fields to create GraphHandler's graph schema
* every GraphHandler an object is saved into will require it's identifiers
* when eg updating fields for an object separate the fields per GraphHandler before sending the request to update each graph

= Extended Object Types =

* Allows for one graph node to have multiple labels
* graph schema is created for both the core object and the extended object
* eg Media Manager's has a node schema for "media" object type, and Image service has a node schema for "image" object type
* the extended object builds it's schema by combining core + extended settings

= Working documents =

[[:Category:Working_documents - Per Service Schemas|Per Service Schemas]]

Service - Currency Table Standard

2026-05-28T03:51:03Z

Seagame: /* currencyTableRate */

= Overview =

Handler service for standard currencyTables that include historical changes.

= Repository =

...

= Schemas =

==ObjectSchemas==

=== currencyTableStandard ===

<syntaxhighlight lang="JavaScript">
{
"objectType": "currencyTableStandard",
"extendObjType": {
"serviceTag": "CurrencyTableManager",
"objectType": "currencyTable"
},
"storageResources": {},
"addOnDataStructure": [],
"fieldNames": {
"baseCurrencyId":{
type: "currency",
requiredOnCreate: true,
},
},
"generatedBy": "userGenerated"
}
</syntaxhighlight>

=== currencyTableRate ===

<syntaxhighlight lang="JavaScript">
{
"objectType": "currencyTableRate",
"storageResources": {
graph: {
storageType: "graph",
graphServerTag: "GraphHandler",
}
},
"addOnDataStructure": [
{
type:"versionedData",
versionedDataLabel: "currencyTableRateValue",
storageResourceTag : "graph",
fieldNames: {
"exchangeRate":{
type: "number",
requiredOnCreate: true,
validation: {},
},
}
},
],
"fieldNames": {
// none, identifier comes from hash or concat of currencyTableID and currencyId
currencyId: {
fromRequiredOnCreate: { // will use data from requiredOnCreateLink that have same relType to use this value, and then
relType: {
serviceTag:"CurrencyTableStandard",
relationshipTag:"isCurrency"
},
fieldName:"" // optional default=same field name eg: now default == currencyId if not defined(use fieldname of object inside link when create)
}
},
currencyTableId: {
fromRequiredOnCreate: {
relType: {
serviceTag:"CurrencyTableStandard",
relationshipTag:"hasCurrencyRate"
},
fieldName:"" // optional default= same field name eg: now default == currencyTableId if not defined(use fieldname of object inside link when create)
}
}
},
identifiers: [
{
type: "identifier",
fieldNames: ["currencyId","currencyTableId"], // from required on create object identifiers
name: "currencyTableRateId", // name of field in database
},
]
"generatedBy": "userGenerated"
}
</syntaxhighlight>

== RelationshipSchemas ==

=== baseCurrency ===

<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "CurrencyTableStandard",
"fieldNames": {},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"serviceTag": "CurrencyTableStandard",
"objectType": "currencyTableStandard"
},
"linkType": "many",
"handler": true,
"requiredOnCreate": true
},
"to": {
"objType": {
"serviceTag": "Currency",
"objectType": "currency"
},
"linkType": "one",
"requiredOnCreate": false,
"handler": true,
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>

=== isCurrency ===

<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "CurrencyTableStandard",
"fieldNames": {},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"serviceTag": "CurrencyTableRate",
"objectType": "currencyTableRate"
},
"linkType": "many",
"handler": true,
"requiredOnCreate": true
},
"to": {
"objType": {
"serviceTag": "Currency",
"objectType": "currency"
},
"linkType": "one",
"requiredOnCreate": false,
"handler": true,
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>

=== hasCurrencyRate ===

<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "CurrencyTableStandard",
"fieldNames": {},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"serviceTag": "CurrencyTableStandard",
"objectType": "currencyTableStandard"
},
"linkType": "one",
"handler": true,
"requiredOnCreate": false
},
"to": {
"objType": {
"serviceTag": "CurrencyTableStandard",
"objectType": "currencyTableRate"
},
"linkType": "many",
"requiredOnCreate": true,
"handler": true,
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>

= Working documents =

[[:Category:Working_documents - Currency Table Standard| Currency Table Standard]]

[[Category:Backend services| Currency Table Standard]]

Per Service Schemas

2026-05-26T00:06:32Z

Seagame: /* Not extendObjType */

= Overview =

Each service manages a schema of object/resources that it is responsible for, this schema is available to other services and frontends. The schema includes a list of fields available for each object.

= File Structure =

* see [[Repository structure#schemas|Repository structure]]

= ObjectSchema | ObjectFieldSchema.js =

== Not extendObjType ==

<syntaxhighlight lang="javascript">
{
objectType: "xx",
shortNameObjectType:"x", // optional, use when generate code create lambda role with long name
canDelete: false, // whether any fields can be deleted // default = false
belongTo: {
serviceTag:"iii",
objectType:"jjj"
},
// how is the object created
// userGenerated there will be generated endpoints for api or sqs (used in importBatchMain) to create object
// systemGenerated must be created by flow/s
// searchResultGenerated see separate notes below
generatedBy: "userGenerated" || "systemGenerated" || "searchResultGenerated" // required
searchResultGeneratedFlowType: {}, // for generatedBy = searchResultGenerated
addOnDataStructure: [ // optional, add for additional setting to objectType
{
// all fields that a user can edit must be in versionedData, and all fields in versionedData must be editable by user
type:"versionedData",
versionedDataLabel: "xx", // versionedData label name
storageResourceTag : "xx", // ref to storegeResourceTag
fieldNames: { // fieldName in versionedData cannot have in in main objectSchema.fieldNames
"aaa":{ // fieldName
type: "xx", // string|integer|number|timestamp|currency|currencyValue|float|special|object|boolean|arrayMixed|arrayNumeric|arrayString
requiredOnCreate: false, // default = false
optionalOnCreate: false, // default = false,
validation: {
itemValidation:{} // for validate item in array
},
// probably impossible to have fromObjType, because data can be changed by user here
fromObjType:{
serviceTag: "xxx",
objectType: "xxx"
},
},
// ...
}
},
{ // can have multiple addOn of type attributeTree
type:"attributeTree",
},
{
type:"translation"
},
{
type:"propertyValue"
},
{
type:"mediaLink"
},
{
type:"rbac"
},
// ...
],
plugInTags: ["a", "b"], // plugIns that can be connected to this objType
storageResources:{
"xxx":{ // storageResourceTag
storageType: "xx", // graph
graphServerTag: "xx", // setting for storageType graph
additionalGraphIndexes:[['fieldName1', 'fieldName2', ...], [...]] // will make graph index with specific fieldName
},
"zzz":{ // storageResourceTag
storageType: "xx", // dynamoDB
// setting for storageType dynamoDB
tableName: "xx",
groupByPartitionKeyField: "xx", // use groupByPartitionKeyField as partition key and not have sort key in dynamoDB, if have multiple identifiers will concat it. And use it as partitionKey.
serviceTag:"zz"// default own service.
}
},
fieldNames: {
xxx: { // fieldName
type: "xx", // string|integer|number|timestamp|currency|currencyValue|float|special|object|boolean|arrayMixed|arrayNumeric|arrayString
randomOnCreate: false, // default = false , can set true in fieldName that part of identifiers and identifiers have single identifierFieldname
requiredOnCreate: false, // default = false
optionalOnCreate: false, // default = false
canUpdate: true, // default = true (only system/flows can edit, no history of changes unless flow manually adds)
validation: {
itemValidation:{} // for validate item in array
}, // maybe ajv syntax
storageResourceTags: ["xx","yy"], // reference to storageResources property
fromObjType:{
serviceTag: "xxx",
objectType: "xxx"
},
hashOnCreate: ["xx", "yy"], // reference to other fieldName,
statusField: true, // use for objectSchema inside flowSchema, identify which field is statusField
},
// ...
},
compositeKeyDeliminator: "xx", // join partitionKey and sortKey
identifiers: [
// for dynamoDB storageType
{
type: "partitionKey",

fieldNames: ["xx","yy"], // composite partition keys in DynamoDB
deliminator: "xx", // optional, defaults to "_"
name: "zz", // name of field in database
// or
fieldName: "xx"

},
{
type: "sortKey",

fieldNames: ["xx","yy"], // composite partition keys in DynamoDB
deliminator: "xx", // optional, defaults to "_"
name: "zz", // name of field in database
// or
fieldName: "xx"

},

// for graph storageType
{
type: "identifier",
fieldNames: ["xx","yy"], // identifier field in graph or composite partition keys in DynamoDB
name: "zzz" // use when save in dynamoDB partitionKey
deliminator: "xx", // optional, defaults to "_"
// or
fieldName: "xx"
},
]
}
</syntaxhighlight>

== extendObjType ==

<syntaxhighlight lang="javascript">
{
// for objects stored in graph this will add another node label
objectType: "xx", // new label to add
extendObjType: { // core object that this object extends
serviceTag: "xxx",
objectType: "xxx"
},
addOnDataStructure: [],
storageResources:{ // these are the storageResources that carry the extended objects settings,
// (see above)
},
fieldNames: {
// (see above)
},
// canDelete/identifiers come from the core object
}
</syntaxhighlight>

== searchResultGenerated ==

* must be created by flow
* eg: variantProduct
* not have any storageResources
* identifiers are automatically searchResultData identifiers
* a searchResult request for this object will enter the searchResultGeneratedFlowType flow which creates searchResultData that can then be queried/sorted
* all relationships must be storageType = lambda, eg translate from variantProduct to variant uses a translateId flow to query the variantProduct identifier (searchResultData) to find the variantId in it's requiredData results
* searchResultGeneratedFlowType takes over after creating searchResultMain record until processRequiredData
* if objectSchema defines any fieldnames, then they are found using a flow, maybe as hooks in per service findData
* when finding direct fieldname, will need to check if requireData already exists, if not enter flow/findData to create
* no fields can be edited, so can show in forms but no updates performed

= Relationships Schema | ObjectRelationships.js =

* stored in top level schemas folder
* parent/child determines relationship direction for graph relationships
* have one service that contains information of each relationship

<syntaxhighlight lang="javascript">
// relationship schema in responsible service
[
{
"xxx": { // relationshipTag - name of relationship type stored in graph
generatedBy: "userGenerated" || "systemGenerated" // default="userGenerated"
canChangeToRelTypes: [
{
relType: { // relType that this relType can change to
serviceTag:"xxx",
relationshipTag: "yyy"
},
changeBy: "user" // "systemNoUserId" | "systemWithUserId" | "user", default="user"
}
// another relType
],
// moveBy allows the relationship to be moved between 2 instances of the same objType only
moveBy: "none" // "systemNoUserId" | "systemWithUserId" | "user" | "none", default="none"
storageResources:{
"xxx":{ // storageResourceTag
storageType: "xx", // dynamoDB | graph | lambda
// if storageType="dynamoDB" will not specify tableName in relationship schema

// setting for storageType graph
graphServerTag: "xx",
additionalGraphIndexes:[['fieldName1', 'fieldName2', ...], [...]], // will make graph index with specific fieldName

// setting for storageType lambda
serviceTag: "xx",
functionName: "xx",
}
},
fieldNames: {
"xxx": { // relationship property name
type: "string", // "string" | "number" ...
requiredOnCreate: false, // default=false
optionalOnCreate: false, // default = false
updateBy: "user" // "systemNoUserId" | "systemWithUserId" | "user" | "none", default="user"
validation: {} // ajv syntax
},
//...other relationship properties
},
links: [
{
storageResourceTags: ["xxx"], // reference from storageResources property
canDelete: false // default = false, if set true will allow delete relationship between 2 objType
from: {
objType: {
serviceTag: "xx",
objectType: "xx"
},
requiredOnCreate: true, // if set true will create relationshipTag when create objType data, if both "from" and "to" linkType="many" should not have requiredOnCreate, exists in "from" or "to" only
linkType: "", // one | many
},
to: {
objType: {
serviceTag: "yy",
objectType: "yy"
},
linkType: "", // one | many
},
requestProperties: {
// if storageType is Lambda and translateIds/linkPath requires properties set them here (eg sellOffer>orderPrice)
tag_deliverTo: {
requestPropertyType: "objectIdentifier",
objType: {
serviceTag: "Locations",
objectType: "locationNode" // deliversToLocationNode
},
identifiersFieldName: "locationNodeId"
},
// ... other request properties
}
}
// ...other link
]
}
}
]

</syntaxhighlight>

= Reference Relationships Schema | RefObjectRelationships.js =

<syntaxhighlight lang="javascript">
// reference to relationshipTag in external service
[
{
objectType: "zz", // objectType in local service
relationshipTag: "xxx", // name of relationshiptag of objType
relationshipServiceTag: "xx" // point to service tag that contain data of relationshipTag of objType
}
]

</syntaxhighlight>

= Flow Schema | FlowSchemas.js =

<syntaxhighlight lang="javascript">
[
{
flowTag: "yyy",
initiateBy:"user", // "user" | "system" -- if receive plugin should be user
handleObj:"one", // "one" | "multi"
statusType:"statusField", // "statusField" | "storedCache" | "none" | "triggerCache"

// statusType="triggerCache" setting
triggerType: "storedCache", // "storedCache" | "switch"
triggerFlowTypes:[
//... triggerFlowType
],

// statusType="statusField" | "triggerCache" | "storedCache" setting:
objType:{},

event:["ownTopic"], // "ownTopic" | "extTopic" | "s3" | "eventBridge" | "lambdaSyncInv" | "lambdaSyncApi" | "generatedCode"

// event="s3" setting
bucketName: "xxx", // bucket for s3 event
createBucket: boolean, // if true will generate new bucket with bucketName if false will point to old bucket that already have

// event="eventBridge" setting
schedules:[
{
name: 'your-scheduled-rate-event-name',
description: 'your scheduled rate event description',
rate: ["rate(1 minute)", ],
input:{}
}
],

// event="generatedCode" setting
generatedCodeConfig:{
generatedCodeTag: "create", // tag for generated code, eg "create" | "update" | "delete"
codeHookTag: "xx", // which codeHook to initiate flow from
// maybe validate: invocationType must exist in "event" array, so don't need to check 2 places when eg creating sns topic
invocationType: "ownTopic", // "ownTopic" | "lambdaSyncInv"

objType: {}, // which cases in the generated code trigger the flow
// .. other settings depending on generated code
}

outputTopic: boolean,

flowSteps:[
In:{ // will generate Topic serviceTag_stage_yyy_In
properties:[], // reference to stepProperties key
messageAttributes: [] // reference to stepProperties key
},
// another flow steps
flowStep1:{ // will generate Topic serviceTag_stage_yyy_Flow1
properties:[], // reference to stepProperties key
messageAttributes: [] // reference to stepProperties key
event:["ownTopic"], // "ownTopic" | "extTopic" | "s3" | "eventBridge" | "lambdaSyncInv" | "lambdaSyncApi" | "generatedCode"
// handle splitting logic into awaitingStep/awaitingMultipleSteps
// handle splitting logic into paginated lambda

plugInHooks: [
{
plugInHookTag: "",
objType:{}, // used to query connection dynamo for an object instance in current flow
},
]
},
Out:{ // will generate Topic serviceTag_stage_yyy_Out
properties:[], // reference to stepProperties key
messageAttributes: [] // reference to stepProperties key
},
]

stepProperties:{
"uuid":{
propertyName:"xxx",
type:"string",
},
"uuid2":{
objectField:{
objType:{},
fieldName:"xx"
},
overwritePropertyName:"xx" // optional, if have objectField and have overwritePropertyName will overwrite fieldName
}
},
}
]
</syntaxhighlight>

= System Text Schema | SystemTextSchemas.js =

<syntaxhighlight lang="javascript">
[
{
namespace: "xxx", // groups files downloaded by frontend
systemTextTag: "yyy",
}
]
</syntaxhighlight>

== Auto generated systemText and namespaces ==

=== systemNotification names ===

* namespace: "sysNotification_{notificationGrouping}"
* systemTextTag: "{notificationTag}"
* eg shown on notification settings page

=== objType names ===

* namespace: "objTypes"
* systemTextTag: "{serviceTag}_{objectType}"
* eg shown on config pages, eg pulldown list of object types

=== objType field name descriptions ===

* namespace: "objType_fielddesc_{serviceTag}_{objectType}"
* systemTextTag: "{fieldname}"
* eg shown on config pages, eg info box for each field name

= System Notification Schema | SystemNotificationSchemas.js =

<syntaxhighlight lang="javascript">
[
{
notificationTag: "xxx",
notificationGrouping: "yyy",
weight: "##",
},
]
</syntaxhighlight>

= Generated S3 files =

* generate multiple files for different uses, eg:
*# list of saved fieldNames for Create
*# list of saved+calculated for Update/Info pages
*# graphSchemas
*# relationships (used by Search/Sort Results)

= Use Cases =

== Find Deployed Service Name ==

* other services can use fixed serviceTag to get deployed serviceName from serviceSchema on S3
* used to build resource names for external services
* eg when one service needs to send a message into an SNS belonging to a different service

== Standard Create, Update, List, Delete pages ==

* List and Delete are maybe not required, use table data system instead.
* object schema can add validation information that can be used on the frontend to check before sending to backend, and by the backend to validate the data before handling

=== Create Object ===

* can configure what fields are shown
* requiredOnCreate fields must be shown

=== Edit Object ===

* users setup any number of pages for object types with configurable fields shown
* fields can be either display only or edit
* each field can adjust it's display properties (perhaps via cssStyles)

== Menu Config ==

When adding menu items can add links to create, update, list, delete objects, user chooses the service then from that service's list of objects and what action is being performed. For update/delete perhaps links to a standard page that asks for the identifier before presenting the page.

== Tabled Data ==

When viewing tabled data the frontend pulls the tableId's config from backend, then when requesting the data also requests the serviceTag > objectType schema for use when displaying the data.

== Code Standardization ==

Code such as middleware validation schema and saving data to databases can be standardized.

== Code Generation ==

Endpoints per object for actions such as Create/Delete/Update can be automatically generated from objectSchema.

=== Code Generation Structure ===

* npm for generic code generation, can be used in any project, includes functions for generating Source files from templates and developer files
* npm for per project specific files, eg templates for the project (Create/Update/.. code)
* Empty Service Template has GenerateCode.js script file in root dir that is run to generate code, it invokes a generation function from generic npm with param that points to per project npm's templates
* generated Source retains hook tags (and any developer added code), so if developer wants to update developer's file with updated template code they can generate code and simply copy generated Source to src folder

= Graph Server Config =

* S3 has a list of graphServerTag's linking to the GraphHandler serviceTag responsible for the graph
* multiple graphServerTags can point to one GraphHandler, combining graphs into one server
* when creating each GraphHandler's graph schemas, for each field split out the fields into each GraphHandler using the graphServerTag, if multiple graphServerTags for a field point to the same GraphHandler combine the fields to create GraphHandler's graph schema
* every GraphHandler an object is saved into will require it's identifiers
* when eg updating fields for an object separate the fields per GraphHandler before sending the request to update each graph

= Extended Object Types =

* Allows for one graph node to have multiple labels
* graph schema is created for both the core object and the extended object
* eg Media Manager's has a node schema for "media" object type, and Image service has a node schema for "image" object type
* the extended object builds it's schema by combining core + extended settings

= Working documents =

[[:Category:Working_documents - Per Service Schemas|Per Service Schemas]]

2025-03-27 Graph Use Case/CreateNode

2026-05-11T08:30:12Z

Seagame: /* CreateNode with setFieldConditionals and deepPathConditional */

= Overview =
= Use Case =
== CreateNode with identifiers ==
'''Example Param'''
<source lang="json">
{
"objType":{
"serviceTag": "xxxx",
"objectType": "yyyy",
},
"objInstanceFull":{
"identifiers":{
"xxxx" : "yyyy"
},
"fields":{
// "optional"
"xxxx" : "yyyy"
}
},
"relationships":[],
"originTimestamp": 1234567890,
"settings":{
"updatePropertiesOnMatch": false
}
}

</source>
'''Example Output'''
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
returnCreateNode: {
objType: {
serviceTag: 'xxxx',
objectType: 'yyyy'
},
properties: { //properties }
},
existsNode: { },
userNode: { // if has userNode send to createNode
objType: { serviceTag: 'UserAccount', objectType: 'user' },
properties: { userId: 'xxxx' }
}
}
},
requestParams: {
// return example send param
}
},
status: "string", // "complete' or "error"
errorsFound: [],
graphServiceTag: "GraphHandler"
}
</syntaxhighlight>

== CreateNode with versionedData ==
'''Example Param'''
<source lang="json">
{
"objType": {
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"objInstanceFull": {
"identifiers": {
"xxxx": "yyyy"
},
"fields": {
"can send all fields of versionedData",
"if send any fields of versionedData will be hook properties then return all "
},
"Relationship": [],
"originTimestamp": 1234567890,
"callingFlow": "string"
}
</source>
'''Exmaple Output'''
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
returnCreateNode: {
objTypes: [
{
serviceTag: "xxxx",
objectType: "yyyy"
}
],
objInstanceFull: {
identifiers: {
//identifiers
},
fields: {
// fields of main node
}
},
existsNode: { },
userNode: {
objTypes: [
{
serviceTag: "UserAccount",
objectType: "user"
}
],
properties: {
userId: "xxxx"
}
},
relationships: []
}
},
requestParams: {
// return example send param
}
},
status: "complete",
errorsFound: [],
graphServiceTag: "GraphHandler"
}
</syntaxhighlight>

== CreateNode with targetNode ==
'''Example Param'''
<source lang="json">
{
"objType": {
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"objInstanceFull": {
"identifiers": {
"xxxx": "yyyy"
},
"fields": {
"//fields"
}
},
"relationships": [
{
"relType": {
"serviceTag": "xxxx",
"relationshipTag": "yyyy"
},
"relationshipProperties": {
"// optional"
},
"relationshipDirection": "from"
"targetObjType": {
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"targetIdentifiers": {
"xxxx": "yyyy"
}
}
],
"originTimestamp": 1234567890,
"settings": {
"updatePropertiesOnMatch": true
}
}

</source>
'''Exmaple Output'''
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
returnCreateNode: {
objTypes: [
{
serviceTag: "xxxx",
objectType: "yyyy"
}
],
objInstanceFull: {
identifiers: {
//identifiers
},
fields: {
// fields of npde
}
},
existsNode: { },
userNode: {
objTypes: [
{
serviceTag: "UserAccount",
objectType: "user"
}
],
properties: {
userId: "xxxx"
}
},
relationships: [
{
objTypes: [
{ serviceTag: 'string', objectType: 'string' }
],
objInstanceFull: {
identifiers: {
// identifiers
}
},
relType: {
serviceTag: 'string',
relationshipTag: 'rel'
},
relationshipProperties: {
// properties
}
}
]
}
},
requestParams: {
// return example send param
}
},
status: "complete",
errorsFound: [],
graphServiceTag: "GraphHandler"
}
</syntaxhighlight>

== CreateNode with setFieldConditionals and deepPathConditional ==
* setFieldConditionals is check field in data before set field by conditional
* deepPathConditional is check requiredOncreate node and Relationship exist , before created
<source lang="json">
{
"objType":{
"serviceTag":"xxx",
"objectType":"yyy"
},
"objInstanceFull":{
"identifiers":{
},
"fields":{

}
},
"setFieldConditionals":[ "// optional default array [ ]"
{
"objType":{
},
"indexValue":{

},
"fieldName":"", "// fieldName want to set"
"passValue":false, "//optional"
"notPassValue":true, "// optional"
"conditionals":[
{
"fieldName":"", "// field value for check"
"value":""
}
]
},
{
// if have multiple check
}
],
"relationships":[
{
"relType":{ },
"relationshipDirection":"",
"targetObjType":{},
"targetIdentifiers":{ }
}
],
"deepPathConditional":[ "// optional default array [ ]"
{
{
"condition":"notExist","// if true can check || 'exist' equal is false"
"conditionCheck":{ "// param it's seems like traversal of getDeepPathSearch"
"nodeStructure":{
"objType":{ },
"fields":{ }
},
"nextPath":{
"relationshipStructure":{
"relType":{

},
"relationshipDirection":""
},
"nodeStructure":{

},
"nextPath": {} "// if have multiple check"
}
}
}
],
"settings":{
"updatePropertiesOnMatch":false
},
"originTimestamp": Date.now() "// number"
}
</source>

== CreateNode with belongTo ==
* Params like create basicNode & versionedData but in objectSchema optional has belongTo If in objectSchema have belongTo will create query and return dataStructure of belongTo
* Must send : x-correlation-base-user-id : xxxx AND x-correlation-target-id : yyyy ( identifiers of that node)

== CreateNode with extendObjtype ==
* create objectSchema that have objectType for create main node eg. objectType: objectA then upload To S3
* create objectSchemathat have extendObjtype for existParentNode eg. objectType: objectB then upload To S3
* Send parameter with identifiers’s objectType of extendObjtype for create Node

== CreateNode with extendObjtype and targetNode ==
* create objectSchema that have objectType for create main node eg. objectType: objectA
* createNode extend with relationship that have relationshipSchema : requiredOnCreate = true to targetNode

== CreateNode With systemGenerated ==
* not send userNode or userId when createNode

[[Category:Working documents| 2025-03-27]]

2025-03-27 Graph Use Case/CreateNode

2026-05-11T08:27:47Z

Seagame: /* CreateNode with setFieldConditionals and deepPathConditional */

= Overview =
= Use Case =
== CreateNode with identifiers ==
'''Example Param'''
<source lang="json">
{
"objType":{
"serviceTag": "xxxx",
"objectType": "yyyy",
},
"objInstanceFull":{
"identifiers":{
"xxxx" : "yyyy"
},
"fields":{
// "optional"
"xxxx" : "yyyy"
}
},
"relationships":[],
"originTimestamp": 1234567890,
"settings":{
"updatePropertiesOnMatch": false
}
}

</source>
'''Example Output'''
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
returnCreateNode: {
objType: {
serviceTag: 'xxxx',
objectType: 'yyyy'
},
properties: { //properties }
},
existsNode: { },
userNode: { // if has userNode send to createNode
objType: { serviceTag: 'UserAccount', objectType: 'user' },
properties: { userId: 'xxxx' }
}
}
},
requestParams: {
// return example send param
}
},
status: "string", // "complete' or "error"
errorsFound: [],
graphServiceTag: "GraphHandler"
}
</syntaxhighlight>

== CreateNode with versionedData ==
'''Example Param'''
<source lang="json">
{
"objType": {
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"objInstanceFull": {
"identifiers": {
"xxxx": "yyyy"
},
"fields": {
"can send all fields of versionedData",
"if send any fields of versionedData will be hook properties then return all "
},
"Relationship": [],
"originTimestamp": 1234567890,
"callingFlow": "string"
}
</source>
'''Exmaple Output'''
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
returnCreateNode: {
objTypes: [
{
serviceTag: "xxxx",
objectType: "yyyy"
}
],
objInstanceFull: {
identifiers: {
//identifiers
},
fields: {
// fields of main node
}
},
existsNode: { },
userNode: {
objTypes: [
{
serviceTag: "UserAccount",
objectType: "user"
}
],
properties: {
userId: "xxxx"
}
},
relationships: []
}
},
requestParams: {
// return example send param
}
},
status: "complete",
errorsFound: [],
graphServiceTag: "GraphHandler"
}
</syntaxhighlight>

== CreateNode with targetNode ==
'''Example Param'''
<source lang="json">
{
"objType": {
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"objInstanceFull": {
"identifiers": {
"xxxx": "yyyy"
},
"fields": {
"//fields"
}
},
"relationships": [
{
"relType": {
"serviceTag": "xxxx",
"relationshipTag": "yyyy"
},
"relationshipProperties": {
"// optional"
},
"relationshipDirection": "from"
"targetObjType": {
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"targetIdentifiers": {
"xxxx": "yyyy"
}
}
],
"originTimestamp": 1234567890,
"settings": {
"updatePropertiesOnMatch": true
}
}

</source>
'''Exmaple Output'''
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
returnCreateNode: {
objTypes: [
{
serviceTag: "xxxx",
objectType: "yyyy"
}
],
objInstanceFull: {
identifiers: {
//identifiers
},
fields: {
// fields of npde
}
},
existsNode: { },
userNode: {
objTypes: [
{
serviceTag: "UserAccount",
objectType: "user"
}
],
properties: {
userId: "xxxx"
}
},
relationships: [
{
objTypes: [
{ serviceTag: 'string', objectType: 'string' }
],
objInstanceFull: {
identifiers: {
// identifiers
}
},
relType: {
serviceTag: 'string',
relationshipTag: 'rel'
},
relationshipProperties: {
// properties
}
}
]
}
},
requestParams: {
// return example send param
}
},
status: "complete",
errorsFound: [],
graphServiceTag: "GraphHandler"
}
</syntaxhighlight>

== CreateNode with setFieldConditionals and deepPathConditional ==
* setFieldConditionals is check field in data before set field by conditional
* deepPathConditional is check requiredOncreate node and Relationship exist , before created
<source lang="json">
{
"objType":{
"serviceTag":"xxx",
"objectType":"yyy"
},
"objInstanceFull":{
"identifiers":{
// identifiers
},
"fields":{
// field
}
},
"setFieldConditionals":[ // optional default array [ ]
{
"objType":{
},
"indexValue":{

},
"fieldName":"", // fieldName want to set
"passValue":false, //optional
"notPassValue":true, // optional
"conditionals":[
{
"fieldName":"", // field value for check
"value":""
}
]
},
{
// if have multiple check
}
],
"relationships":[
{
"relType":{ },
"relationshipDirection":"",
"targetObjType":{},
"targetIdentifiers":{ }
}
],
"deepPathConditional":[ // optional default array [ ]
{
{
"condition":"notExist",// || if true can check || 'exist' equal is false
"conditionCheck":{ // param it's seems like traversal of getDeepPathSearch
"nodeStructure":{
"objType":{ },
"fields":{ }
},
"nextPath":{
"relationshipStructure":{
"relType":{

},
"relationshipDirection":""
},
"nodeStructure":{

},
"nextPath": {} // if have multiple check
}
}
}
],
"settings":{
"updatePropertiesOnMatch":false
},
"originTimestamp": Date.now() // number
}
</source>

== CreateNode with belongTo ==
* Params like create basicNode & versionedData but in objectSchema optional has belongTo If in objectSchema have belongTo will create query and return dataStructure of belongTo
* Must send : x-correlation-base-user-id : xxxx AND x-correlation-target-id : yyyy ( identifiers of that node)

== CreateNode with extendObjtype ==
* create objectSchema that have objectType for create main node eg. objectType: objectA then upload To S3
* create objectSchemathat have extendObjtype for existParentNode eg. objectType: objectB then upload To S3
* Send parameter with identifiers’s objectType of extendObjtype for create Node

== CreateNode with extendObjtype and targetNode ==
* create objectSchema that have objectType for create main node eg. objectType: objectA
* createNode extend with relationship that have relationshipSchema : requiredOnCreate = true to targetNode

== CreateNode With systemGenerated ==
* not send userNode or userId when createNode

[[Category:Working documents| 2025-03-27]]

2025-03-27 Graph Use Case/CreateNode

2026-05-11T08:13:32Z

Seagame: /* CreateNode with setFieldConditionals and deepPathConditional */

= Overview =
= Use Case =
== CreateNode with identifiers ==
'''Example Param'''
<source lang="json">
{
"objType":{
"serviceTag": "xxxx",
"objectType": "yyyy",
},
"objInstanceFull":{
"identifiers":{
"xxxx" : "yyyy"
},
"fields":{
// "optional"
"xxxx" : "yyyy"
}
},
"relationships":[],
"originTimestamp": 1234567890,
"settings":{
"updatePropertiesOnMatch": false
}
}

</source>
'''Example Output'''
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
returnCreateNode: {
objType: {
serviceTag: 'xxxx',
objectType: 'yyyy'
},
properties: { //properties }
},
existsNode: { },
userNode: { // if has userNode send to createNode
objType: { serviceTag: 'UserAccount', objectType: 'user' },
properties: { userId: 'xxxx' }
}
}
},
requestParams: {
// return example send param
}
},
status: "string", // "complete' or "error"
errorsFound: [],
graphServiceTag: "GraphHandler"
}
</syntaxhighlight>

== CreateNode with versionedData ==
'''Example Param'''
<source lang="json">
{
"objType": {
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"objInstanceFull": {
"identifiers": {
"xxxx": "yyyy"
},
"fields": {
"can send all fields of versionedData",
"if send any fields of versionedData will be hook properties then return all "
},
"Relationship": [],
"originTimestamp": 1234567890,
"callingFlow": "string"
}
</source>
'''Exmaple Output'''
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
returnCreateNode: {
objTypes: [
{
serviceTag: "xxxx",
objectType: "yyyy"
}
],
objInstanceFull: {
identifiers: {
//identifiers
},
fields: {
// fields of main node
}
},
existsNode: { },
userNode: {
objTypes: [
{
serviceTag: "UserAccount",
objectType: "user"
}
],
properties: {
userId: "xxxx"
}
},
relationships: []
}
},
requestParams: {
// return example send param
}
},
status: "complete",
errorsFound: [],
graphServiceTag: "GraphHandler"
}
</syntaxhighlight>

== CreateNode with targetNode ==
'''Example Param'''
<source lang="json">
{
"objType": {
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"objInstanceFull": {
"identifiers": {
"xxxx": "yyyy"
},
"fields": {
"//fields"
}
},
"relationships": [
{
"relType": {
"serviceTag": "xxxx",
"relationshipTag": "yyyy"
},
"relationshipProperties": {
"// optional"
},
"relationshipDirection": "from"
"targetObjType": {
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"targetIdentifiers": {
"xxxx": "yyyy"
}
}
],
"originTimestamp": 1234567890,
"settings": {
"updatePropertiesOnMatch": true
}
}

</source>
'''Exmaple Output'''
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
returnCreateNode: {
objTypes: [
{
serviceTag: "xxxx",
objectType: "yyyy"
}
],
objInstanceFull: {
identifiers: {
//identifiers
},
fields: {
// fields of npde
}
},
existsNode: { },
userNode: {
objTypes: [
{
serviceTag: "UserAccount",
objectType: "user"
}
],
properties: {
userId: "xxxx"
}
},
relationships: [
{
objTypes: [
{ serviceTag: 'string', objectType: 'string' }
],
objInstanceFull: {
identifiers: {
// identifiers
}
},
relType: {
serviceTag: 'string',
relationshipTag: 'rel'
},
relationshipProperties: {
// properties
}
}
]
}
},
requestParams: {
// return example send param
}
},
status: "complete",
errorsFound: [],
graphServiceTag: "GraphHandler"
}
</syntaxhighlight>

== CreateNode with setFieldConditionals and deepPathConditional ==
** setFieldConditionals is check field in data before set field by conditional
** deepPathConditional is check requiredOncreate node and Relationship exist , before created

== CreateNode with belongTo ==
* Params like create basicNode & versionedData but in objectSchema optional has belongTo If in objectSchema have belongTo will create query and return dataStructure of belongTo
* Must send : x-correlation-base-user-id : xxxx AND x-correlation-target-id : yyyy ( identifiers of that node)

== CreateNode with extendObjtype ==
* create objectSchema that have objectType for create main node eg. objectType: objectA then upload To S3
* create objectSchemathat have extendObjtype for existParentNode eg. objectType: objectB then upload To S3
* Send parameter with identifiers’s objectType of extendObjtype for create Node

== CreateNode with extendObjtype and targetNode ==
* create objectSchema that have objectType for create main node eg. objectType: objectA
* createNode extend with relationship that have relationshipSchema : requiredOnCreate = true to targetNode

== CreateNode With systemGenerated ==
* not send userNode or userId when createNode

[[Category:Working documents| 2025-03-27]]

2025-03-27 Graph Use Case/CreateNode

2026-05-11T08:05:35Z

Seagame: /* Using Case */

= Overview =
= Use Case =
== CreateNode with identifiers ==
'''Example Param'''
<source lang="json">
{
"objType":{
"serviceTag": "xxxx",
"objectType": "yyyy",
},
"objInstanceFull":{
"identifiers":{
"xxxx" : "yyyy"
},
"fields":{
// "optional"
"xxxx" : "yyyy"
}
},
"relationships":[],
"originTimestamp": 1234567890,
"settings":{
"updatePropertiesOnMatch": false
}
}

</source>
'''Example Output'''
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
returnCreateNode: {
objType: {
serviceTag: 'xxxx',
objectType: 'yyyy'
},
properties: { //properties }
},
existsNode: { },
userNode: { // if has userNode send to createNode
objType: { serviceTag: 'UserAccount', objectType: 'user' },
properties: { userId: 'xxxx' }
}
}
},
requestParams: {
// return example send param
}
},
status: "string", // "complete' or "error"
errorsFound: [],
graphServiceTag: "GraphHandler"
}
</syntaxhighlight>

== CreateNode with versionedData ==
'''Example Param'''
<source lang="json">
{
"objType": {
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"objInstanceFull": {
"identifiers": {
"xxxx": "yyyy"
},
"fields": {
"can send all fields of versionedData",
"if send any fields of versionedData will be hook properties then return all "
},
"Relationship": [],
"originTimestamp": 1234567890,
"callingFlow": "string"
}
</source>
'''Exmaple Output'''
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
returnCreateNode: {
objTypes: [
{
serviceTag: "xxxx",
objectType: "yyyy"
}
],
objInstanceFull: {
identifiers: {
//identifiers
},
fields: {
// fields of main node
}
},
existsNode: { },
userNode: {
objTypes: [
{
serviceTag: "UserAccount",
objectType: "user"
}
],
properties: {
userId: "xxxx"
}
},
relationships: []
}
},
requestParams: {
// return example send param
}
},
status: "complete",
errorsFound: [],
graphServiceTag: "GraphHandler"
}
</syntaxhighlight>

== CreateNode with targetNode ==
'''Example Param'''
<source lang="json">
{
"objType": {
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"objInstanceFull": {
"identifiers": {
"xxxx": "yyyy"
},
"fields": {
"//fields"
}
},
"relationships": [
{
"relType": {
"serviceTag": "xxxx",
"relationshipTag": "yyyy"
},
"relationshipProperties": {
"// optional"
},
"relationshipDirection": "from"
"targetObjType": {
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"targetIdentifiers": {
"xxxx": "yyyy"
}
}
],
"originTimestamp": 1234567890,
"settings": {
"updatePropertiesOnMatch": true
}
}

</source>
'''Exmaple Output'''
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
returnCreateNode: {
objTypes: [
{
serviceTag: "xxxx",
objectType: "yyyy"
}
],
objInstanceFull: {
identifiers: {
//identifiers
},
fields: {
// fields of npde
}
},
existsNode: { },
userNode: {
objTypes: [
{
serviceTag: "UserAccount",
objectType: "user"
}
],
properties: {
userId: "xxxx"
}
},
relationships: [
{
objTypes: [
{ serviceTag: 'string', objectType: 'string' }
],
objInstanceFull: {
identifiers: {
// identifiers
}
},
relType: {
serviceTag: 'string',
relationshipTag: 'rel'
},
relationshipProperties: {
// properties
}
}
]
}
},
requestParams: {
// return example send param
}
},
status: "complete",
errorsFound: [],
graphServiceTag: "GraphHandler"
}
</syntaxhighlight>

== CreateNode with setFieldConditionals and deepPathConditional ==

== CreateNode with belongTo ==
* Params like create basicNode & versionedData but in objectSchema optional has belongTo If in objectSchema have belongTo will create query and return dataStructure of belongTo
* Must send : x-correlation-base-user-id : xxxx AND x-correlation-target-id : yyyy ( identifiers of that node)

== CreateNode with extendObjtype ==
* create objectSchema that have objectType for create main node eg. objectType: objectA then upload To S3
* create objectSchemathat have extendObjtype for existParentNode eg. objectType: objectB then upload To S3
* Send parameter with identifiers’s objectType of extendObjtype for create Node

== CreateNode with extendObjtype and targetNode ==
* create objectSchema that have objectType for create main node eg. objectType: objectA
* createNode extend with relationship that have relationshipSchema : requiredOnCreate = true to targetNode

== CreateNode With systemGenerated ==
* not send userNode or userId when createNode

[[Category:Working documents| 2025-03-27]]

2025-03-06 - Graph Handler Docs

2026-05-06T06:01:13Z

Seagame: /* MoveNodeProperties */

= GraphHandler Function =
== CreateNode ==
'''Use Case of CreateNode''' >>> https://izara.io/wiki/index.php/2025-03-27_Graph_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
* setFieldConditionals
** type : array
** Required : optional
* deepPathConditional
** type : array
** Required : optional
* callingFlowConfig
** Type: object
** Required : optional
* callingFlowConfig.callingFlow
** Type: string
** Required : optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType": {
"objectType": string,
"serviceTag": string
},
"objInstanceFull": {
"identifiers": {
// ...identifier
},
"fields": {
// ...fields
}
},
setFieldConditionals: [ // optional default array
{
objType: { },
indexValue: { nameSpace: 'ex-011', systemTextTag: 'Gate-011' }, // index field : value
fieldName: '', // fieldName want to set
passValue: 'false', optional
notPassValue: 'true', //optional
conditionals: [ optional ] // condition check field
}
],
"relationships": [
{
"relType": {
"serviceTag": string,
"relationshipTag": string
},
"relationshipProperties": {
//... key and value of targetIdentifiers
},
"relationshipDirection": string, // "from" | "to"
"targetObjType": {
"serviceTag": string,
"objectType": string
},
"targetIdentifiers": {
//... targetIdentifiers
}
}
],
deepPathConditional: [ // optional default array
{
condition: 'notExist', //
conditionCheck: { // traversal
nodeStructure: {
objType: { },
fields: { }
},
nextPath: {
relationshipStructure: {
relType: { },
relationshipDirection: 'to'
},
nodeStructure: {
objType: { },
fields: { }
}
}
}
}
],
"originTimestamp": number, // timestamp when create
"settings": {
"updatePropertiesOnMatch": boolean // default=false
},
"callingFlow": string,
"callingFlowProperties": object,
}
</syntaxhighlight>

=== 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.relationships
** Type: array
** Description: data from relationships in targetNode
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* Status
** Type: string
** Description: Status from create node. Return "error" or "complete".
* errorsFound
** Type: array
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">

{
returnValue: {
queryResult: {
returnCreateNode: {
objTypes: [
{
serviceTag: "string",
objectType: "string"
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//...fields
}
},
existsNode: { },
userNode: { // // if has userNode send to createNode
objTypes: [
{
"serviceTag": "UserAccount",
"objectType": "user"
}
],
properties: {
//...properties
}
},
relationships: [ // optional : if has requiredOnCreated , createNode with targetNode
{
objTypes: [
{ serviceTag: 'string', objectType: 'string' }
],
objInstanceFull: {
identifiers: {
// identifiers
}
},
relType: {
serviceTag: 'string',
relationshipTag: 'rel'
},
relationshipProperties: {
// properties
}
},
]
}
},
requestParams: {
// return example send param
}
},
status: "string", // "complete' or "error"
errorsFound: [],
graphServiceTag: "GraphHandler"
}

</syntaxhighlight>

== GetNode ==
'''Use Case of GetNode''' >>> https://izara.io/wiki/index.php/2025-04-23_Graph_Use_Case/GetNode_and_GetNodes#Use_Case_GetNodes
=== 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
* versionedDataLabels
** Type: Array
** Required : optional
* settings.updatePropertiesOnMatch
** Type: Boolean
** Required : optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":string,
"objectType":string
},
"objInstanceFull":{
"identifiers":{
// ...identifier
},
"fields":{
// ...fields
}
},
"versionedDataLabels":[
//…versionedData
],
"settings": {
"returnSystemFieldsName" :boolean // default = true or false
}
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* returnValue.queryResult
** Type: object
* queryResult.refactoredNodes
** Type: object
** Description: return object from getNode
* refactoredNodes.objTypes
** Type: array
* refactoredNodes.objInstanceFull
** Type: object
* refactoredNodes.objInstanceFull.identifiers
** Type: object
* refactoredNodes.objInstanceFull.fields
** Type: object
* refactoredNodes.versionDataSystemFields
** Type: object
* refactoredNodes.versionDataSystemFields.versionedDataLabel
** Type: object
* queryResult.requestParam
** Type: object
** Description: return example send param
* errorsFound
** Type: string
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
refactoredNodes: {
objTypes: [
{
serviceTag: "string",
objectType: "string",
}
],
objInstanceFull: {
identifiers: {
//… identifier
},
fields: {
//…fields
}
},
versionDataSystemFields: {
versionedDataLabel: {
originTimestamp: number,
forMatchedId: "string",
versionedDataId: "string"
}
}
}
},
requestParam: {
// return example send param
}
},
errorsFound: [],
graphServiceTag: ''
}
</syntaxhighlight>

== GetNodes ==
'''Use Case of GetNodes''' >>> https://izara.io/wiki/index.php/2025-04-23_Graph_Use_Case/GetNode_and_GetNodes#Use_Case_GetNodes
=== Request Parameters ===
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* fields
** Type : object
** Required: true
* versionedDataLabels
** Type: Array
** Required : optional
* settings.returnSystemFieldsName
** Type: Boolean
** Required : optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":string,
"objectType":string
},
"fields":{
//…fields with matching value
},
"versionedDataLabels":[
//…versionedDataLabels
],
"settings":{
"returnSystemFieldsName":boolean // default=false
}
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResults
** Type: object
* queryResults.getNodesReturnValues
** Type: array
* getNodesReturnValues.objTypes
** Type: array
* getNodesReturnValues.objInstanceFull
** Type: object
* getNodesReturnValues.objInstanceFull.identifiers
** Type: object
* getNodesReturnValues.objInstanceFull.fields
** Type: object
* getNodesReturnValues.versionDataSystemFields
** Type: object
* getNodesReturnValues.versionDataSystemFields.versionedDataLabel
** Type: object
* requestParams
** Type: object
* errorsFound
** Type: string
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: {
getNodesReturnValues: [
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//.. all fields-1
}
},
versionDataSystemFields: {}
},
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifier
},
fields: {
//...all fields-2
}
},
versionDataSystemFields: {
versionedDataLabel: {
originTimestamp: number,
forMatchedId: 'string',
versionedDataId: 'string'
}
}
}
]
},
requestParams: {
// return example send param
}
}
}
</syntaxhighlight>

== UpdateNode ==
''' Use Case of UpdateNode''' >>> https://izara.io/wiki/index.php/2025-08-03_-_Graph_Use_Case/UpdateNode
=== 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: object
** Required : true
* objInstanceFull.fields
** Type : object
** Required: true
** Description : can not send fields to update mainNode and versionedData together
* versionedDataIds
** Type: object
** Required: optional
* originTimestamp
** Type: number
** Required: true
* settings
** Type: object
** Required: optional
* callingFlow
** Type: string
** Required: optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType": {
"serviceTag": string,
"objectType": string
},
"objInstanceFull": {
"identifiers": {
//…identifiers
},
"fields": {
//…fields
// can not be send fields of mainNode and versionedData in fields together!
}
},
"versionedDataIds": {},
"originTimestamp": number, //// timestamp when update
"settings": {},
"callingFlow": string
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* returnValue.queryResult
** Type: object
** Description: data from created node
* queryResult.objTypes
** Type: array
** Description: serviceTag and objectType
* queryResult.objInstanceFull
** Type: object
** Description: identifiers and fields
* queryResult.userId
** Type: object
** Description: data that update from user Account
* queryResult.versionDataSystemFields
** Type: object
** Description: optional return versionedData
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* returnValue.Status
** Type: string
** Description: status from updated node // error or complete
* returnValue.errorsFound
** Type: array
* returnValue.graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//...identifiers
},
fields: {
//...fields
}
},
userId: {
// if have userNode send to updated
},
versionDataSystemFields: {
versionedDataLabel: {
}
}
},
requestParams: {
// return example send param
}
},
status: 'string',//"complete" // "error"
errorsFound: [],
graphServiceTag: 'string'
}
</syntaxhighlight>

== CreateRelationship ==
''' Use Case of CreateRelationship''' >>> https://izara.io/wiki/index.php/2025-08-01_-_Graph_Use_Case/CreateRelationship
=== Request Parameters ===
* firstObject
** Type: object
** Required: true
* secondObject
** Type: object
** Required: true
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* identifiers
** Type: object
** Required : true
* createRelationshipIfNothave
** Type : array
** Required: optional
** Description : using createRelationshipIfNothave for check relationship if not has created , can check both firstNode and SeconNode or onCreateAddRelationships
* onCreateAddRelationships
** Type: array of object
** Required: optional
* relType
** Type: object
** Required: true
* relationshipDirection
** Type: string
** Required: true
* relationshipProperties
** Type: object
** Required: true
* Settings
** Type: object
** Required: true
* settings.updateRelPropsWhenExist
** Type: boolean
** Required: optional
* callingFlow
** Type: string
** Required: optional
* callingFlowConfig
** Type: object
** Required: optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject": {
"objType": {
"serviceTag": string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"createRelationshipIfNothave": [ // optional
{
"onMatchRelationship": {
"relType": {
"serviceTag": string,
"relationshipTag": string
},
"relationshipProperties": {},
"relationshipDirection": string
},
"onMatchNode": {
"objType": {
"serviceTag":string,
"objectType": string
},
"fields": {
}
}
}
],
"onCreateAddRelationships": [
{
"objType": {
"serviceTag":string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"relType": {
"serviceTag":string,
"relationshipTag":string
},
"relationshipProperties": {
//…properties
},
"relationshipDirection":string // “from” , “to”
}
]
},
"secondObject": {
"objType": {
"serviceTag":string,
"objectType":string
},
"identifiers": {
//…identifiers
},
"onCreateAddRelationships": [
//…optional
]
},
"relType": {
"serviceTag":string,
"relationshipTag":string
},
"relationshipDirection":string, // “from” , “to”
"relationshipProperties": {
//…properties
},
"settings": {
"updateRelPropsWhenExist": boolean,
},
"callingFlow": "xxxx",
"callingFlowProperties": {
"graphServiceName": string
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.relationship
** Type: object
* queryResult.relationship.relType
** Type: object
* queryResult.relationship.relationshipProperties
** Type: object
* queryResult.firstNode
** Type: object
** Description: return data structure from firstNode
* queryResult.secondNode
** Type: object
** Description: return data structure from secondNode
* queryResult..onCreateAddRelationships
** Type: array
** Description: return data structure from onCreateAddRelationships
* returnValue.firstObject
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* Status
** Type: string
** Description: status from create node // error or complete
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
relationship: {
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//…properties
}
},
firstNode: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: { //… identifiers },
fields: {
//… all fields
}
},
onCreateAddRelationships: [
{
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: {
//… identifiers
},
fields: {
//… all fields
}
},
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//… all properties
}
}
]
},
secondNode: {
objTypes: [
{
serviceTag: 'string',
objectType: 'string'
}
],
objInstanceFull: {
identifiers: { //… identifiers },
fields: {
//… all fields
}
},
onCreateAddRelationships: [
//… optional
]
}
}
}
}
requestParams: {
// return example send param

},
Status: 'string', //“complete” // “error”
errorsFound: []
}
}
</syntaxhighlight>

== GetRelationship ==
=== Request Parameters ===
* firstObject
** Type: object
** Required: optional
* secondObject
** Type: object
** Required: optional
* objType
** Type: object
** Required: true
** Description: has serviceTag and objectType
* identifiers
** Type: object
** Required: true
* relType
** Type: object
** Required: true
** Description: has relationshipTag and serviceTag
* relId
** Type: string
** Required: true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag":string,
"objectType":string
},
"identifiers":{
//…identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"relType":{ // required
"relationshipTag": string,
"serviceTag": string
},
"relId": 'string' // // required
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
* Type: object
* queryResult.relType
** Type: object
* queryResult.relationshipProperties
** Type: object
** Description: return relId and properties
* returnValue.toObject
** Type: object
** Description: return toObject if not send secondObject from param
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* errorsFound
** Type: array
* graphServiceTag
** Type: string

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: {
relType: {
serviceTag: 'string',
relationshipTag: 'string'
},
relationshipProperties: {
//…properties : 'string’
}
},
toObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: {
identifiers: {
//
},
fields: { }
}
},
requestParams: {
// return example send param
}
}
}

</syntaxhighlight>

== UpdateRelationship ==
=== Request Parameters ===
* firstObject
** Type: object
** Required: optional
* secondObject
** Type: object
** Required: Optional
* objType
** Type: object
** Required: true
** Description: has serviceTag and objectType
* identifiers
** Type: object
** Required: true
* relId
** Type: string
** Required: true
* relType
** Type: object
** Required: true
** Description: has relationshipTag and serviceTag
* relationshipProperties
** Type: object
** Required: true
** Description: send properties that want to update
* relationshipDirection
** Type: string
** Required: optional
* callingFlow
** Type: string
** Required: optional
=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag": string,
"objectType": string
},
"identifiers":{
//…identifiers
}
},
"relId": string,
"relType":{
"serviceTag":string,
"relationshipTag":string
},
"relationshipProperties":{
//… properties that want to update
},
"relationshipDirection": string, // "from" // “to”
"callingFlow": string
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.firstObject And secondObject
** Type: object
** Description : return objType {seviceTag and objectType} And identifiers
* queryResult.relId
** Type: string
* queryResult.relType
** Type: object
** Description: return {seviceTag and relationshipTag}
* queryResult.relationshipDirection
** Type: string
* queryResult.updatePropertiesParam
** Type: object
** Description: return properties to updated
* queryResult.oldRelationshipProperties
** Type: object
** Description: return old properties before update
* queryResult.newRelationshipProperties
** Type: object
** Description: return new properties after updated
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type : string
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
firstObject: {
objType: {
serviceTag: "string",
objectType: "string"
},
identifiers: {
//…identifiers
}
},
secondObject: {
objType: {
serviceTag: "string",
objectType: "string"
},
identifiers: {
//…identifiers
}
},
relId: "string",
relType: {
serviceTag: "string",
relationshipTag: "string"
},
relationshipDirection: "string",
updatePropertiesParam: {
//… properties updated
},
oldRelationshipProperties: {
// … old properties before update
},
newRelationshipProperties: {
//… new properties after updated
}
}
},
requestParams: {
// return example send param
}
status: “string”, // "complete",”error”
errorsFound: []
}
</syntaxhighlight>

== GetNodeAndRelationship ==
=== Request Parameters ===
* sourceObjType
** Required: true
** Description: has serviceTag and objectType
* sourceIdentifiers
** Type: object
** Required: true
* sourceVersionedDataLabels
** Type: object
** Required: optional
* targetRelationships
** Type: Array
** Required: true
* relTypeAndDirection
** Type: object
** Required: true
* relTypeAndDirection.relType
** Type: object
** Required: true
** Description: has serviceTag and relationshipTag
* relTypeAndDirection.relationshipProperties
** Type: object
** Required: optional
* relTypeAndDirection.relationshipDirection
** Type: String
** Required: optional
* targetObjects
** Type: Array
** Required: Optional
* targetObjects.objType
** Type: object
** Required: required if send targetObjects in param
* targetObjects.identifiers
** Type: object
** Required: optional should have objType if identifiers exists
* targetObjects.versionedDataLabels
** Type: object
** Required: optional have objType if versionedDataLabels exists

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"sourceObjType": { // required
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"sourceIdentifiers": {}, // required
"sourceVersionedDataLabels": [], // optional
"targetRelationships": [ //required
{
"relTypeAndDirection": { // required
"relType": {
"serviceTag": "xxxx",
"relationshipTag": "rel"
},
"relationshipProperties": {},//optional
"relationshipDirection": "" // required
},
"targetObjects": [ // optional
{
"objType": {
"serviceTag": "xxxx",
"objectType": "yyyy"
},
"identifiers": {}, // optional
"versionedDataLabels": [] // optional have objType if versionedDataLabels exists
}
]
},
// if have multiple relTypeAndDirection
],
"settings": {} // defaulf = false >>> if have versionedDataLabels want to return all field of versionedata: settings = { returnSystemFieldsName: true }
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.objTypes
** Type: array of object
** Description: return {serviceTag and objectType}
* queryResult.objInstanceFull
** Type: object
** Description: return {identifiers and fields}
* queryResult.relNodes:
** Type: array
* relNodes.relType
** Type: object
** Description: return {serviceTag and relationshipTag}
* relNodes.relationshipProperties
** Type: object
* relNodes.objTypes
** Type: array of object
** Description: return {serviceTag and objectType}
* relNodes.objInstanceFull
** Type: object
** Description: return {identifiers and fields}
* requestParams
** Type: object
** Description: return same requestParams
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: {},
fields: { }
},
relNodes: [
{
relType: {
serviceTag: 'xxxx',
relationshipTag: 'rel'
},
relationshipProperties: { },
objTypes: [
{
serviceTag: 'xxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: {},
fields: {
// field
}
},
versionDataSystemFields: {
'0VersionDataLabel': {
originTimestamp:
forMatchedId:
versionedDataId:
}
}
}
]
}
},
requestParam : {
// return example send param
},
errorsFound: [],
graphServiceTag: "GraphHandler"
}

</syntaxhighlight>

== ChangeRelationshipType ==
=== Request Parameters ===
* firstObject
** Type : object
** Required : true
* secondObject
** Type : object
** Required : true
* objType
** Type : object
** Required : true
* Identifiers
** Type : object
** Required : true
* oldRelTypeAndDirection
** Type : object
** Required : true
* oldRelTypeAndDirection.relType
** Type : object
** Required : true
* oldRelTypeAndDirection.relationshipDirection
** Type : string
** Required : true
* oldRelTypeAndDirection.relationshipProperties
** Type : object
** Required : optional
* newRelType
** Type : object
** Required : true
* originTimestamp
** Type : number
** Required : true
* changedByUserId
** Type : String
** Required : true
* callingFlow
** Type : String
** Required : optional
* settings
** Type : object
** Required : optional
** Description : default > settings.changeMultipleRelationships : false // if send settings.changeMultipleRelationships : true >> can change multiple relType

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"secondObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"oldRelTypeAndDirection":{
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"old"
},
"relationshipDirection":"from",
"relationshipProperties":{
//Properties
}
},
"newRelType":{
"serviceTag":"xxxx",
"relationshipTag":"new"
},
"originTimestamp":1234567890,
"changedByUserId":"xxxx",
"callingFlow":"yyyy",
"settings":{
"changeMultipleRelationships": boolean: // default false
}
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.newRelationshipType
** Type: object
* newRelationshipType.relType
** Type: object
* newRelationshipType.relationshipDirection
** Type: string
* newRelationshipType.relationshipProperties
** Type: object
* queryResult.oldRelationshipType
** Type: object
* oldRelationshipType.relType
** Type: object
* oldRelationshipType.relationshipDirection
** Type: string
* oldRelationshipType.relationshipProperties
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
newRelationshipType: {
relType: {
serviceTag: "xxxx",
relationshipTag: "new"
},
relationshipDirection: "" // 'from' or 'to'
relationshipProperties: {}
},
oldRelationshipType: {
relType: {
serviceTag: "xxxx",
relationshipTag: "old"
},
relationshipDirection: "" // 'from' or 'to'
relationshipProperties: {}
}
},
requestParams : {
// return example send param
}
},
status: "complete" // or error,
errorsFound: [],
graphServiceTag : 'GraphHandeler'
}

</syntaxhighlight>

== DeleteRelationship ==
=== Request Parameters ===
* fromObject
** Type : object
** Required : optional
* secondObject
** Type : object
** Required : optional
* objType
** Type : object
** Required : true
* Identifiers
** Type : object
** Required : true
* relType
** Type : object
** Required : true
* relId
** Type: string
** Required : true
* relationshipDirection
** Type: string
** Required : optional
* callingFlow
** Type: string
** Required : true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"firstObject":{ // optional default object
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"secondObject":{ // optional default object
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
},
"identifiers":{
//identifiers
}
},
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"yyyy"
},
"relId":"string"
},
"relationshipDirection":"string"// "from" or "to"
"callingFlow":"string"
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.objects
** Type: array
* queryResult.objTypes
** Type: array
* queryResult.objInstanceFull.identifiers
** Type: object
* queryResult.objInstanceFull.fields
** Type: object
** Description: return data of fromObject and secondObject
* queryResult.userNode
** Type: object
** Description: return data of userNode
* queryResult.resultDeleteRel
** Type : string
** Description: return status Relationship Delete
* requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
objects: [
{
objTypes: [
{
serviceTag: "xxxx",
objectType: "yyyy"
}
],
objInstanceFull: {
identifiers: {
// identifiers
},
fields: {
// fields
}
}
},
{
// if have multiple object objTypes
}
],
userNode: {
objTypes: [
{
serviceTag: "UserAccount",
objectType: "user"
}
],
objInstanceFull: {
identifiers: {
userId: "zzz"
}
}
},
resultDeleteRel: "Relationship Deleted" // default
},
requeatParam: {
// return example send param
},
status: "string", //default "complete" or "error"
errorsFound: []
}
}

</syntaxhighlight>

== DeleteNode ==
=== Request Parameters ===
* objType
** Type : object
** Required: true
* objType.objectType
** Type : string
** Required : true
* objType.serviceTag
** Type : string
** Required : true
* identifiers
** Type : object
** Required: true

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"objType":{
"serviceTag":"xxx",
"objectType":"yyy"
},
"identifiers":{
//
}
}
</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResults
** Type: object
* queryResults.resultDeleteNode
** Type: Boolean
** Description: return status deleted node >> true or false
* requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
** Description: return status deleted node >> complete or error
* errorsFound
** Type: array
* graphServiceTag
** Type: string
=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResults: { resultDeleteNode: true }, // true or false
requestParams: {
// return example send param
}
},
status: 'string', // 'complete' or 'error'
errorsFound: [],
graphServiceTag: 'GraphHandler'
}
</syntaxhighlight>

== MoveRelationship ==

=== Request Parameters ===
* sourceObject
** Type : object
** Required : true
** Description: required objType: {serviceTag , objectType} and identifiers
* targetObjType
** Type : object
** Required : true
** Description: required objType: {serviceTag , objectType}
* relType
** Type : object
** Required : true
** Description: required objType: {serviceTag , relationshipTag}
* relationshipDirection
** Type : object
** Required : true
* moveToIdentifiers
** Type : object
** Required : true
* moveByUserId
** Type : String
** Required : true
* originTimestamp
** Type : number
** Required : true
* settings
** Type : object
** Required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
"sourceObject":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyy"
},
"identifiers":{
// identifiers
}
},
"targetObjType":{
"objType":{
"serviceTag":"xxxx",
"objectType":"yyyy"
}
},
"relType":{
"serviceTag":"xxxx",
"relationshipTag":"rel"
},
"relationshipDirection":"from", // "to"
"moveToIdentifiers":{
// target identifiers
},
"moveByUserId":"xxxx",
"originTimestamp":1234567890,
"settings":{}
}

</syntaxhighlight>

=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.moveRelationship
** Type: object
* moveRelationship.sourceObject
** Type: object
** Description: return data of sourceObject
* moveRelationship.relationship
** Type: string
** Description: return data of after move relationship
* moveRelationship.moveToObject
** Type: object
** Description: return data of moveToObject
* moveRelationship.historyData
** Type: object
** Description: return properties {old target identifiers and originTimestamp} after moveRelationship
* moveRelationship.userNode
** Type: object
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String

=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
moveRelationship: {
sourceObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
}
},
relationship: {
relType: {
serviceTag: 'xxxx',
relationshipTag: 'rel'
},
relationshipProperties: { originTimestamp: 1234567890 }
},
moveToObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: { }
},
historyData: {
relationshipProperties: { }
},
userNode: {
objTypes: [{ serviceTag: 'UserAccount', objectType: 'user' }],
objInstanceFull: { }
}
}
},
requestParam: {
}
}
status: "complete" // or error,
errorsFound: [],
graphServiceTag: 'GraphHandler'
}

</syntaxhighlight>

== MoveNodeProperties ==
=== Request Parameters ===
* sourceObject
** type: object
** required : true
* targetIdentifiers
** type : object
** required : true
* moveProperties
** type : array
** required : true // index minimum = 1
* updateProperties
** type : object
** required : true
* movePropertiesConditions
** type : array
** required : optional

=== Request Example ===
<syntaxhighlight lang="javascript">
{
sourceObject: {
objType: { },
identifier: { }
},
targetIdentifiers: { },
moveProperties: [ ],
updateProperties: { },
movePropertiesConditions: [ // optional
{
checkObject: 'target', // "source" | "target"
onSetObject: 'target', // "source" | "target"
onPassValue: true,
onNotPassCondition: false, // optional
fieldNameConditions: [ ]
}
]
}
</syntaxhighlight>
=== Output Response ===
* returnValue
** Type: object
* queryResult
** Type: object
* queryResult.moveNodeProperties
** Type: object
* moveNodeProperties.sourceObject
** Type: object
** Description: return data of sourceObject
* moveRelationship.moveFieldToObject
** Type: string
** Description: return data after moveFieldToObject
* moveRelationship.movedFields
** Type: object
** Description: return data field of moveToObject
* returnValue.requestParams
** Type: object
** Description: return same requestParams
* status
** Type: string
* errorsFound
** Type: array
* graphServiceTag
** Type: String
=== Return Example ===
<syntaxhighlight lang="javascript">
{
returnValue: {
queryResult: {
moveNodeProperties: {
sourceObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyyy'
}
],
objInstanceFull: {
identifiers: { },
fields: { }
}
},
moveFieldToObject: {
objTypes: [
{
serviceTag: 'xxxx',
objectType: 'yyy'
}
],
objInstanceFull: {
identifiers: { },
fields: {

}
},
movedFields: { Fields: { } } //
}
}
},
requestParam: { },
status: 'complete',
errorsFound: [],
graphServiceTag: 'GraphHandler'
}
</syntaxhighlight>
[[Category:Working documents| 2025-03-06]]