cnRelationServices Class Reference

Description

Relation Services
Uses the infohub GOM (Generic Object Model).

Public Member Functions
async	addToRelation (left_nodeid, relation_name, sid_list, cb)
	constructor (ctx)
async	createRelation (left_nodeid, relation_data, cb)
async	deleteRelation (relation_sid, cb)
async	getRelation (left_nodeid, relation_name, cb, relation_data=null)
async	getRelationList (query, cb)
async	getRelationListByNode (left_nodeid, query, cb)
async	patchRelation (rel_data, relation_id, cb)
async	removeFromRelation (left_nodeid, relation_name, sid_list)
async	saveRelation (cnRel, left_nodeid, cb)

Function Documentation

addToRelation()

async addToRelation	(		left_nodeid,
			relation_name,
			sid_list,
			cb )

constructor()

constructor

(

ctx

)

Parameters

{Context}

ctx Infohub Context

Since

08.2025, jh

createRelation()

async createRelation	(		left_nodeid,
			relation_data,
			cb )

Parameters

{*}	left_nodeid
{*}	relation_data
{*}	cb

Returns

{Promise<ApiResponse>} Returns the created relation

deleteRelation()

async deleteRelation	(		relation_sid,
			cb )

Parameters

{*}	relation_sid
{*}	cb

Returns

{Promise<RestResponse>} Returns the response from the delete operation

getRelation()

async getRelation	(		left_nodeid,
			relation_name,
			cb,
			relation_data = null )

Get relation by name or create it if it does not exist by using relation_data.

Parameters

{*}	left_nodeid
{*}	relation_name
{*}	cb

getRelationList()

async getRelationList	(		query,
			cb )

Parameters

{*}	query = { 'members' : ' ... ' 'filter' : ' ... ' }
{*}	cb

Returns

{Promise<ApiResponse>} Returns array of relations

getRelationListByNode()

async getRelationListByNode	(		left_nodeid,
			query,
			cb )

Parameters

{*}	left_nodeid
{*}	query
{*}	cb

Returns

{Promise<ApiResponse>} { status : data : array of relations

patchRelation()

async patchRelation	(		rel_data,
			relation_id,
			cb )

removeFromRelation()

async removeFromRelation	(		left_nodeid,
			relation_name,
			sid_list )

saveRelation()

async saveRelation	(		cnRel,
			left_nodeid,
			cb )