2025-08-03 - Graph Use Case/UpdateNode

From Izara Wiki
Revision as of 05:59, 4 August 2025 by Seagame (talk | contribs)
Jump to navigation Jump to search

Overview

Using Case

UpdateNode Basic Case

Example Param

{
  "objType": {
    "serviceTag": "xxxx",
    "objectType": "yyyy"
  },
  "objInstanceFull": { // required
    "identifiers": { 
     // identifiers
    },
    "fields": { 
      // properties that want to update
    }
  },
  "originTimestamp": number, // Date.now()
  "callingFlow": "xxx" // optional
}

Example Output

{
  returnValue: {
    queryResult: {
      objType: {
        serviceTag: "xxxx",
        objectType: "yyyy"
      },
      objInstanceFull: {
        identifiers: {
          /// identifiers
        },
        fields: {
          // properties after updated
        }
      },
      userId: {}
    },
    requestParam: {
      // return example send param
    }
  },
  status: "complete", // or error
  errorsFound: [],
  graphServiceTag: "GraphHandler"
}

UpdateNode and VersionData

Example Param

 {
  "objType": {
     "serviceTag": "xxxx",
     "objectType": "yyyy"
  },
  "objInstanceFull": {
     "identifiers": {
       // identifiers
     },
     "fields": {
       // Node properties && properties of versionedData that want to ubdate
     },
  },
  "versionedDataIds":{ // requied if want to update properties of versionedData
   "versionedDataLabel" : "versionedDataIds" 
   // key : value
  },
  "originTimestamp": number, // Date.now()
  "setting":{ // optional
    returnSystemFieldsName = boolean  // true or false
  },
  "callingFlow": "xxxx"
}

Example Output

{
 returnValue: {
  queryResult: {
    objTypes: [
      { serviceTag: 'xxxx', objectType: 'yyyy' }
    ],
    objInstanceFull: {
      identifiers: {
        // identifiers
      },
      fields: {
        // properties after updated
       }
      },
    userId: { },
    versionDataSystemFields: {
      versionedDataLabel: {
        originTimestamp: number,
        forMatchedId: 'xxxx',
        versionedDataId: 'yyyy'
        }
      }
   },
   requestParams: {
    // return example send param
    }
  },
  status: 'complete', // or error
  errorsFound: [],
  graphServiceTag: 'GraphHandler'
}