2025-04-23 Graph Use Case/GetNode and GetNodes

From Izara Wiki
Jump to navigation Jump to search

Overview

Using Case

GetNode with identifiers

  • Example param
{
 "objType":{
    "serviceTag":"xxxx",
    "objectType":"yyyy"
 },
 "objInstanceFull":{
    "identifiers":{
       "xxxx":"yyyy"
    },
    "fields":{
    }
 },
 "versionedDataLabels":[]
}
  • Output
{
  objType: { serviceTag: 'xxxx', objectType: 'yyyy' },
  objInstanceFull: {
	identifiers: {
  	// identifiers
	},
	fields: {
  	// fields
	}
  }
}

GetNode with VersionedData Case false

  • Example param
{
   "objType":{
      "serviceTag":"xxxx",
      "objectType":"yyyy"
   },
   "objInstanceFull":{
      "identifiers":{
       "identifiers"
      },
      "fields":{
         "fields"
      }
   },
   "versionedDataLabels":[
      "versionedDataLabel"
   ],
   "settings":{
      "returnSystemFieldsName":false // or not send settings
   }
}
  • Output
{
    objTypes: [ { serviceTag: 'xxxx', objectType: 'yyyy' } ],
    objInstanceFull: {
      identifiers: {
       //identifiers
      },
      fields: {
        // fields with versionedData properties
      }
    }
  }

GetNode with VersionedData Case true

  • Example param
{
  "objType":{
     "serviceTag":"xxxx",
     "objectType":"yyyy"
  },
  "objInstanceFull":{
     "identifiers":{
        "identifiers"
     },
     "fields":{
        "fields"
     }
  },
  "versionedDataLabels":[
     "versionedDataLabel"
  ],
  "settings": {"returnSystemFieldsName" :true}
}
  • Output
{
  objTypes: [ { serviceTag: 'xxxx', objectType: 'yyyy' } ],
  objInstanceFull: {
    identifiers: {
     //identifiers
    },
    fields: {
      // fields with versionedData's properties
    }
  },
  versionDataSystemFields: {
    verionedDataLabels: {
      originTimestamp: 1234567890,
      forMatchedId: 'string',
      versionedDataId: 'string'
    }
  }
}

GetNode with AnyValue

  • Example param
{
  "objType": {
    "serviceTag": "xxxx",
    "objectType": "yyyy"
   },
  "objInstanceFull": {
	"identifiers": {
	// identifiers
   },
	"fields": {
	  "storage": {
	    "anyValue": [
           "xxx",
           "yyy"
		   "anyVAlue of identifiers"
		  ]
		}
	  }
	},
	"versionedDataLabels": []
}

- Note!: can use anyValue inside objInstanceFull.identifiers or objInstanceFull.fields - In the Params that are sent, both "identifiers" and AnyValue must be included. At least one of the values must match the data in order to return the correct result.

Would you like this rephrased more formally or used in a technical document?

  • Output
{
	objTypes: [ { serviceTag: 'xxxx', objectType: 'yyyy' } ],
	objInstanceFull: {
  	identifiers: { //identifiers },
  	fields: {
    	// fields
      }
	}
  }

- Note!: If any of the values in anyValue sent do not match the data defined in the Graph will be "returnValue": { } or fields :{ } // empty object