2025-07-29- Action EndPoint

Create EndPoint

Create Basic

Request Example

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

Return Example

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

Create Node and Relationship

Request Example

{
 "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
     }
   }
 ]
}

Return Example

{
 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

Request Example

{
 "objectType": "xxxxx",
   "objInstanceFull": { // required
   "identifiers": {
     //identifiers
   },
   "fields": {
     // fields or if have fields of versionedData
   }
 },
 "versionedDataIds": { // optional
    “versionedDataLabel”: versionedDataIds
 }
}

Return Example

{
 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

Request Example

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

Return Example

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