Changes

Creating SmartConnect Functions

1,104 bytes added, 15:01, 23 June 2023
Delete Multiple Upload Files
: '''''sample3:'''''
: An example query with brackets: ( (cf_somefield1 like '%whatever%' or cf_somefield2 like  '%whatever%'  or cf_somefield3 like  '%whatever%'  or cf_somefield4like  '%whatever%' ) and (cf_someotherfield1='whatever' or cf_someotherfield2='whatever else'))
: criteria: [{ "andor": "(", "field": "cf_somefield1", "operator": "like", "value": "whatever" },{ "andor": "or", "field": "cf_somefield2", "operator": "like", "value": "whatever" },{ "andor": "or", "field": "cf_somefield3", "operator": "like", "value": "whatever" },{ "andor": "or", "field": "cf_somefield4", "operator": "like", "value": "whatever" },{ "andor": ") and (", "field": "cf_someotherfield1", "operator": "=", "value": "whatever" },{ "andor": "or", "field": "cf_someotherfield2", "operator": "=", "value": ""whatever else" }]
: sortby: 
: othersettings : {"getstorevalue":"0","keyformat":"0"}
[[File:APIFunctionDeleteL1User.PNG|800px]]
 
====Delete Multiple Upload Files====
<!-- 138847 - API function to delete files -->
After the July 2023 upgrade, new function to delete files from Upload - Multiple Files Storage fields was added.
'''Function Name'''  -  3.09.6 Delete Files in Level One<br />
'''Description'''  - Delete existing files from a multiple file field in [[Category:Universal_Tracking_Application|Universal Tracking Application]] Level 1 record<br />
'''Object Type'''  -  Submission Manager - Grant<br />
'''Action Type '''  -  Files - Delete<br />
'''Field List'''  - cf_multiplefilefield
 
 
<u>'''Sample'''</u><br/>
'''Description'''  - To delete existing files from a multiple file field in Submission Manager Level 1<br/>
'''Mandatory fields'''<br/>
objectid -  is the [[Universal Tracking Application]] Level 1 id (opportunityid) where the file to be deleted is located.<br/>
fieldid -  the field id of the multiple file field<br/>
filename -  the filename of the file to be deleted
 
--Begin custom parameter --<br />
jsonrset : [{"objectid":"1223454","fieldid":"3163245","filename":"147807_dup.png"},{"objectid":"1223454","fieldid":"2697568","filename":"128895.png"}]<br />
--End custom parameter--
===Transaction===
<!--134010 - SmartConnect API link and unlink transactions from Objects-->
 '''Function Name'''  -  3.10.3.2  Create or Update Transaction Record in Submission Manager L1 (API v2)<br />
'''Description'''  - Create new transaction record attached to a Submission Manager L1 record <br />
'''Object Type'''  -  Submission Manager - Transactions<br />
'''Action Type '''  - Update<br />
'''Field List'''  -  sf_Object ID;;sf_Subject;;sf_Status;;sf_Type;translevel;cf_Remarks;;
Note that translevel is new in version 2 where translevel=1 for UTA L1 and translevel=2 for UTA L2.
sf_Object ID -  is the object(UTA L1) the transaction would be attached to.<br/>
sf_Type -  [[Transaction_Custom_and_Standard_Field_Types|Transaction Type]] of the transaction record.<br/>
sf_Status - [[Transaction_Status|Transaction Status]] of the transaction record. <br/>
translevel -  is the UTA Level (UTA L1/L2) the transaction would be attached to. <span style="color: #ff0000;">(NEW that is implemented in API v2)</span>
--Begin custom parameter --<br />
jsonrset :  [{"recordid":"0","sf_Object ID":"1069788410697883","sf_Type":"21842119","sf_Status":"82626","sf_Subjecttranslevel":"Test Transaction Record1","translevelsf_Subject":"1Test Transaction Record"}]<br />
--End custom parameter--
 
'''<span style="color: #ff0000;">New Endpoint</span>: '''/API/2/transactions/
[[File:Transactions_01.png|800px]]
<u>'''Sample C''' - creating new transaction record in Submission Mgr L2 from API v2</u><br data-attributes="/">
 
<!--134010 - SmartConnect API link and unlink transactions from Objects-->
<u>'''Sample C''' - creating new transaction record in Submission Mgr L2 from API v2</u><br/>
<!--134010 - SmartConnect API link and unlink transactions from Objects--><br/>
 '''Function Name'''  -  3.10.3.2 Create or Update Transaction Record in Submission Manager L2 (API v2)<br/>
 '''Description'''  - Create new transaction record attached to a Submission Manager L2 record<br/>
 '''Object Type'''  -  Submission Manager - Transactions<br/>
 '''Action Type '''  - Update<br/>
 '''Field List'''  -  sf_Object ID;;sf_Subject;;sf_Status;;sf_Type;;cf_Remarks;;<br/>
 '''Function Name'''  -  Create or Update Transaction Record Note that translevel is new in Submission Manager L2 (API v2)<br data-attributesversion 2 where translevel=1 for UTA L1 and translevel="%20/"> '''Description'''  - Create new transaction record attached to a Submission Manager 2 for UTA L2 record.<br data-attributes="%20/"> '''Object Type'''  -  Submission Manager - Transactions<br data-attributes="%20/"> '''Action Type '''  - Update<br data-attributes="%20/"> '''Field List'''  -  sf_Object ID;;sf_Subject;;sf_Status;;sf_Type;translevel
Note that translevel is '''Mandatory fields''' to add a new transaction record:<br/>recordid -  the unique identifier from the transaction table. To create new in version 2 where record, recordid should be '0'<br/>sf_Object ID -  is the object(UTA L2) the transaction would be attached to.<br/>sf_Type -  [[Transaction_Custom_and_Standard_Field_Types|Transaction Type]] of the transaction record.<br/>sf_Status - [[Transaction_Status|Transaction Status]] of the transaction record.<br/>translevel=1 for -  is the UTA Level (UTA L1 and translevel=2 for UTA /L2) the transaction would be attached to. <span style="color: #ff0000;">(NEW that is implemented in API v2)</span><br/>
'''Mandatory fields''' to add a new transaction record:--Begin custom parameter --<br data-attributes="/"> recordid -  the unique identifier from the transaction table. To create new record,  jsonrset : [{"recordid should be '":"0'<br data-attributes="/,"> sf_Object sf_Object ID -  is the object(UTA L2) the transaction would be attached to.":"10697974","sf_Type":"2184","sf_Status":"82626","sf_Subject":"Test Transaction Record","translevel":"2"}]<br data-attributes="/"> sf_Type  --End custom parameter--  [[Transaction_Custom_and_Standard_Field_Types|Transaction Type]] of the transaction record.<br data-attributes="/"> sf_Status - [[Transaction_Status|Transaction Status]] of the transaction record.
'''<span style="color: #ff0000;">New Endpoint</span>: '''/API/2/transactions/<br/>
 translevel -  is the UTA Level (UTA L1/L2) the transaction would be attached to. <span style="color: #ff0000;">(NEW that is implemented in API v2)</span>  --Begin custom parameter --<br data-attributes="%20/"> jsonrset : [{"recordid"[File:"0","sf_Object ID":"10697974","sf_Type":"2184","sf_Status":"82626","sf_Subject":"Test Transaction Record","translevel":"2"}Transactions_02.png|800px]]<br data-attributes="%20/"> --End custom parameter--  '''<span style="color: #ff0000;">New Endpoint</span>: '''/API/2/transactions/
====Delete Transaction Record====
<!--134010 - SmartConnect API link and unlink transactions from Objects-->
This new feature to link/unlink transactions is only available in APIv2 and only for L1 & L2 transactions.
 
<u>'''Sample A - Link existing transactions to an existing L1'''</u><br/>
 '''Field List'''  -  cf_5469887
'''Mandatory fields''' <br data-attributes="/"> sf_Object sf_Object ID -  is the object(UTA L1 id) the transaction would be attached to.<br/>  translevel translevel -  level in the UTA to link the transaction to.<br/> sf_ transaction id -  is the existing transaction record id.<br/> islink -  indicates to link the transaction to a record.<br/> cf_5469887 -  transaction custom field. --Begin custom parameter --<br data-attributes="%20/"> jsonrset : [{"recordid":"0","sf_Object ID":"1123456","translevel":"1","cf_5469887":"Test linking Transaction to SML1","sf_transaction id":"6165326","islink":"1"}]  --End custom parameter--
--Begin custom parameter --<br/>
 jsonrset : [{"recordid":"0","sf_Object ID":"1123456","translevel":"1","cf_5469887":"Test linking Transaction to SML1","sf_transaction id":"6165326","islink":"1"}]<br/>
 --End custom parameter--<br/>
<u>'''Sample B - Unlink existing transactions to an existing L1'''</u><br data-attributes="/">
  '''Field List'''  -  
'''Mandatory fields''' <br/>  sf_Object sf_Object ID -  is the object(UTA L1 id) the transaction would be attached to.<br/>  translevel translevel -  level in the UTA to link the transaction to.<br/>  sf_ transaction sf_ transaction id -  is the existing transaction record id.<br/>  unlink -  indicates to link the transaction to a record.<br/>
--Begin custom parameter --<br/>
  jsonrset : [{"sf_Object ID":"1123456","translevel":"1","sf_transaction id":"6165326","unlink":"1"}]<br/>  --End custom parameter--<br/>
<u>'''Sample C - Link existing transactions to an existing L2'''</u><br data-attributes="/">
'''Mandatory fields''' <br/>
  sf_Object sf_Object ID -  is the object(UTA L2 id) the transaction would be attached to.<br/>  translevel translevel -  level in the UTA to link the transaction to.<br/>  sf_ transaction sf_ transaction id -  is the existing transaction record id.<br/>  islink islink -  indicates to link the transaction to a record.<br/>  cf_5469887 cf_5469887 -  transaction custom field.<br/>
--Begin custom parameter --<br/>
  jsonrset : [{"recordid":"0","sf_Object ID":"50268865","translevel":"2","cf_5469887":"Test linking Transaction to SML2","sf_transaction id":"6165326","islink":"1"}]<br/>  --End custom parameter--<br/>
<u>'''Sample D - Unlink existing transactions to an existing L2'''</u><br/>
'''Mandatory fields''' <br/>
  sf_Object sf_Object ID -  is the object(UTA L2 id) the transaction would be attached to.<br/>  translevel translevel -  level in the UTA to link the transaction to.<br/>  sf_ transaction sf_ transaction id -  is the existing transaction record id.<br/>  unlink -  indicates to link the transaction to a record.<br/>
--Begin custom parameter --<br/>
  jsonrset : [{"sf_Object ID":"50268865","translevel":"2","sf_transaction id":"6165326","unlink":"1"}]<br/>--End custom parameter--<br/>
===UTA Consumer/Provider===
Smartstaff
1,385
edits