Smartstaff
1,385
edits
Changes
no edit summary
'''Optional field'''<br/>
criteriavalue - when the [[Report|report]] has [[Setting_Text_Criteria_–_Logical_Operators_in_a_Report|text criteria]], values for the criteria(s) should be indicated in this field. If report contains multiple criteria, values should be delimited by double semi-colon eg. "VALUE_1;;VALUE_2".
=====A report query on the number of assessors grouped by specialty=====
'''Description''' - A sample that will display the number of Assessors based on their specialty<br />
===Metadata===
This function will retrieve the metadata of the selected '''Object Type'''.<br />
====Get Metadata of a Universal Tracking Application====
'''Function Name''' - 3.04.1 Get Metadata Sample 1: CMS360°: Application Metadata<br />
'''Field List''' - companies.*
No parameters are needed to retrieve metadata.<br />
====Get Metadata from Contacts====
<!--63342 - SmartConnect API - metadata option to include Orgs/Contacts-->
'''Field List''' - contacts.*
No parameters are needed to retrieve metadata.
===Update===
This function will create new records or update existing records based on the selected '''Object Type'''.<br/>
====Update====
=====Create/Update organization record=====
'''Action Type ''' - Update<br />
'''Field List''' - sf_Name;;sf_Is External;;sf_Parent Company ID;;sf_Address;;sf_Address 2;;sf_City;;sf_State / Province;;sf_Zip / Postal Code;;sf_Country;;cf_EIN Number;;cf_1523156;;sf_Category ID List<br />
<u>'''Sample 1A'''</u><br/>
'''Description''' - Create new organization record<br/>
sf_Parent Company ID - is the company holder or the parent company for the organization to be added.<br/>
sf_Is External - either "1" for external and "0" for internal organization
--Begin custom parameter --<br />
[[File:APIFunctionSample6f.PNG|800px]]
====Update Associations====
===Download File===
This function will download the file.<br/>
====Download File(s) from a company profile====
<!--71968 - SmartConnect Function - Download File does not download the file-->
'''Object Type''' - Company<br />
'''Action Type ''' - Download File<br />
'''Field List''' -<br />
'''Mandatory fields''' to download a file:<br/>
filename - name of the file to be downloaded.<br/>
objectid: 1688407<br />
fieldid: 1523157<br />
--End custom parameter--<br />
Note: In the API website, the content of the file will be shown in the Response section as seen below.<br />
[https://api.smartsimple.com/API/1/report/?url=https://api.smartsimple.com/API/1/report/&companyid=825646&alias=api&username=dataimport@smartsimple.com&password=smartsimple1&apitoken=W0t2dV58fmZGR1lzUmVDc2xibnd8BEdfAgMBAg~~&filename=Test.txt&objectid=1688407&fieldid=1523157| Click here to download the file]<br />
[[File:APIFunctionDownloadFile1.PNG|800px]]
===Search File===
This function will retrieve a list of files by searching for a keyword.<br />
====Search Files Method Sample 1: Search Case Documents====
'''Function Name''' - 3.07.1 Search Files Method Sample 1: Search Case Documents<br />
'''Object Type''' - Case Management 360° - Case<br />
'''Action Type ''' - Search Files<br />
'''Field List''' - cf_Case Documents;;sf_Application Template Type;;sf_Customer<br />
--Begin custom parameter --<br />
===System Variables===
This function will retrieve a list of all the global [[System_Variables|system variables]], get a single record based on the System Variable ID or update the name or value of the [[System_Variables|system variables]] using the System Variable ID.<br/>
<!--71972 - SmartConnect Function: System Variables - does not show when using '/devtools/dev_api.html'-->
====List====
===Variables Replace===
This function will pass the parameters: 1. objectid and 2. content (block of text) which will be run thru the variable processor and return the results as json JSON.
====Variables Replace - Company====
'''Function Name''' - 3.09.1 System Variables Replace - User<br />
'''Description''' - passing the [[Determining_the_companyid|Company ID]] and the desired content<br />
'''Object Type''' - Company<br />
'''Action Type ''' - Variables Replace<br />
'''Field List''' - <br />
[[File:APIFunctionVariablesReplace1.PNG|800px]]
====Variables Replace - User====
====Variables Replace - UTA L1====
====Variables Replace - UTA L2====
====Variables Replace - UTA L3====
==See Also==
[[SmartConnect_-_RESTful_API|SmartConnect - RESTful API]] <br data-attributes="%20/">
