2025-07-29- Action EndPoint: Difference between revisions

From Izara Wiki
Jump to navigation Jump to search
No edit summary
Line 2: Line 2:


=== Create Basic ===
=== Create Basic ===
''' requestParam '''
''' Request Example'''
<syntaxhighlight lang="javascript">
<syntaxhighlight lang="javascript">
{
{
Line 11: Line 11:
}
}
</syntaxhighlight>
</syntaxhighlight>
''' returnOutput '''
''' Return Example '''
<syntaxhighlight lang="javascript">
<syntaxhighlight lang="javascript">
{
{
Line 33: Line 33:


=== Create Node and Relationship ===
=== Create Node and Relationship ===
''' requestParam '''
''' Request Example '''
<syntaxhighlight lang="javascript">
<syntaxhighlight lang="javascript">
{
{
Line 58: Line 58:
}
}
</syntaxhighlight>
</syntaxhighlight>
''' returnOutput '''
 
''' Return Example '''
<syntaxhighlight lang="javascript">
<syntaxhighlight lang="javascript">
{
{
Line 85: Line 86:


== Update EndPoint ==
== Update EndPoint ==
''' requestParam '''
''' Request Example '''
<syntaxhighlight lang="javascript">
<syntaxhighlight lang="javascript">
{
{
Line 99: Line 100:
}
}
</syntaxhighlight>
</syntaxhighlight>
''' returnOutput '''
''' Return Example '''
<syntaxhighlight lang="javascript">
<syntaxhighlight lang="javascript">
{
{
Line 125: Line 126:


== Get EndPoint ==
== Get EndPoint ==
''' requestParam '''
''' Request Example '''
<syntaxhighlight lang="javascript">
<syntaxhighlight lang="javascript">
{
{
Line 134: Line 135:
}
}
</syntaxhighlight>
</syntaxhighlight>
''' returnOutput '''
''' Return Example '''
<syntaxhighlight lang="javascript">
<syntaxhighlight lang="javascript">
{
{
Line 147: Line 148:
  }
  }
</syntaxhighlight>
</syntaxhighlight>
[[Category:Working documents| 2025-07-30]]

Revision as of 04:26, 30 July 2025

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": {
   "identifiers": {
    //identifiers
   },
   "fields": {
    // fields or if have fields of versionedData
   }
 }
}

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
    }
   }
 }
Retrieved from "https://izara.io/wiki/index.php?title=2025-07-29-_Action_EndPoint&oldid=3434"