Difference between revisions of "Creating SmartConnect Functions"
From SmartWiki
(→SmartConnect Function Samples) |
|||
| Line 32: | Line 32: | ||
|| | || | ||
[[Image:GetCompany.PNG|thumb|right|851x230px|<strong>Get Company</strong>]] | [[Image:GetCompany.PNG|thumb|right|851x230px|<strong>Get Company</strong>]] | ||
| − | + | |- | |
| + | || | ||
==='List'=== | ==='List'=== | ||
|| | || | ||
[[Image:ListSample.PNG|thumb|right|851x230px|<strong>List Level One</strong>]] | [[Image:ListSample.PNG|thumb|right|851x230px|<strong>List Level One</strong>]] | ||
| − | |||
|- | |- | ||
|| | || | ||
| Line 42: | Line 42: | ||
|| | || | ||
[[Image:UpdateCompany.PNG|thumb|right|851x230px|<strong>Update Company</strong>]] | [[Image:UpdateCompany.PNG|thumb|right|851x230px|<strong>Update Company</strong>]] | ||
| − | |||
|- | |- | ||
|| | || | ||
| Line 48: | Line 47: | ||
|| | || | ||
[[Image:DownloadFiles.PNG|thumb|right|851x230px|<strong>Download Files from Level One</strong>]] | [[Image:DownloadFiles.PNG|thumb|right|851x230px|<strong>Download Files from Level One</strong>]] | ||
| − | |||
|- | |- | ||
|| | || | ||
| Line 54: | Line 52: | ||
|| | || | ||
[[Image:ListFiles.PNG|thumb|right|851x230px|<strong>List Files from Level One</strong>]] | [[Image:ListFiles.PNG|thumb|right|851x230px|<strong>List Files from Level One</strong>]] | ||
| − | |||
|- | |- | ||
|| | || | ||
| Line 60: | Line 57: | ||
|| | || | ||
[[Image:SearchFiles.PNG|thumb|right|851x230px|<strong>Search Files from Level One</strong>]] | [[Image:SearchFiles.PNG|thumb|right|851x230px|<strong>Search Files from Level One</strong>]] | ||
| − | |||
|- | |- | ||
|| | || | ||
| Line 66: | Line 62: | ||
|| | || | ||
[[Image:ListNotes.PNG|thumb|right|851x230px|<strong>List Notes from a Company</strong>]] | [[Image:ListNotes.PNG|thumb|right|851x230px|<strong>List Notes from a Company</strong>]] | ||
| − | |||
|- | |- | ||
|| | || | ||
| Line 72: | Line 67: | ||
|| | || | ||
[[Image:ListMultipleAddresses.PNG|thumb|right|851x230px|<strong>Get all multiple addresses of a Company</strong>]] | [[Image:ListMultipleAddresses.PNG|thumb|right|851x230px|<strong>Get all multiple addresses of a Company</strong>]] | ||
| − | |||
|- | |- | ||
|| | || | ||
| Line 78: | Line 72: | ||
|| | || | ||
[[Image:UpdateMultipleAddresses.PNG|thumb|right|851x230px|<strong>Update multiple addresses of a Company</strong>]] | [[Image:UpdateMultipleAddresses.PNG|thumb|right|851x230px|<strong>Update multiple addresses of a Company</strong>]] | ||
| − | |||
|- | |- | ||
|| | || | ||
Revision as of 13:36, 7 March 2018
SmartConnect functions are specific to individual copies of SmartSimple so you can only use the functions that are have been previously established in that copy. The article describes how you add functions to an instance.
Contents
Creating a New Function
You need to have Global User Administrator permissions in order to add JSON functions.
1. Log into the copy of SmartSimple where you wish to add the function.
2. Navigate to Global Settings
3. Click on the Connectivity tab
4. Click on the SmartConnect API link
- Any existing Functions are displayed
5. Click on the + button to create a new function.
Function Settings
Each function has the following settings:
- Name – you will use this name to call the function from your own code.
- Description – used to provide documentation as to the function’s purpose.
- Object Type – a list of all SmartSimple objects within this instance. This will include; Report (reports you have created in the instance), Organization (company records), Users (system users and contacts), and each Universal Tracking Application™ Level 1, Level 2 and Level 3 type that you have created in the instance.
- Action Types – this defines the action to be taken by the function. The following actions are available: GET, LIST, UPDATE, DOWNLOAD FILE, and LIST FILES. Details on these Action Types / Methods are available in the following section.
- Field List – this restricts the fields that are to be retrieved from the underlying object.
SmartConnect Function Samples
| Function | Sample |
'Get' |
|
'List' |
|
'Update' |
|
'Download File' |
|
'List File' |
|
'Search File' |
|
'List Notes' |
|
'List Multiple Addresses' |
|
'Update Multiple Addresses' |
|
See Also
JSON API (SmartConnect)
JSON API (SmartConnect) Prerequisite
Using JSON functions
JSON API (SmartConnect) Standard Field Names
