2025-07-29- Action EndPoint

Create EndPoint

Create Basic

requestParam

{
 "objectType": "xxxxx",
 "fieldNames": {
  //fields or if have fields of versionedData
 }
}

returnOutput

{
 "objType": {
   "objectType": "xxxxx",
   "serviceTag": "yyyyy"
 },
 "objInstanceFull": {
   "identifiers": {
      //identifiers
   },
   "fields": {
     //fields
   }
 },
 "relationships": [],
 "status": "complete",  // or "error"
 "errorsFound": []
}

Create Node and Relationship

requestParam

{
 "objectType": "xxxx",
 "fieldNames": {
  // fields or if have fields of versionedData
 },
 "relationships": [
   {
     "relType": {
       "serviceTag": "xxxx",
       "relationshipTag": "rel"
     },
     "targetObjType": {
       "serviceTag": "xxxx",
       "objectType": "yyyy"
     },
     "relationshipDirection": "xxxx", // 'from' or 'to'
     "targetIdentifiers": {
       // identifiers
     }
   }
 ]
}

returnOutput

{
 "objectType": "xxxx",
 "fieldNames": {
   // fields or if have versionedData
 },
 "relationships": [
   {
     "relType": {
       "serviceTag": "xxxx",
       "relationshipTag": "rel"
     },
     "targetObjType": {
       "serviceTag": "xxxx",
       "objectType": "yyyy"
     },
     "relationshipDirection": "xxxx", //'from' or 'to'
     "targetIdentifiers": {
       // targetIdentifiers
     }
   }
 ]
}

Update EndPoint

requestParam

{
 "objectType": "xxxxx",
 "objInstanceFull": {
   "identifiers": {
    //identifiers
   },
   "fields": {
    // fields or if have fields of versionedData
   }
 }
}

returnOutput

{
 "returnValues": {
   "objType": {
     "objectType": "xxxxx",
     "serviceTag": "yyyyy"
   },
   "objInstanceFull": {
     "identifiers": {
        //identifiers
     },
     "fields": {
        //fields
     }
   },
   "versionedDataIds": {
    // if send fields of versionedData will return versionedDataIds
  }
 },
 "status":"complete",  // or "error"
 "errorsFound": []
}

Get EndPoint

requestParam

{
  "objectType": "xxxxx",
  "identifiers": {
   //identifiers
  }
}

returnOutput

{
  response: {
   identifiers: {
     //identifiers
   },
   fields: { 
     //fields
    }
   }
 }