Smartstaff
1,385
edits
Changes
no edit summary
* '''Action Type''' – this defines the action to be taken by the function. The following actions are available: GET META, UPDATE META, GET, LIST, UPDATE, UPDATE ASSOCIATIONS, LIST ASSOCIATIONS, DOWNLOAD FILE, LIST FILES, SEARCH FILES, LIST NOTES and VARIABLE REPLACE. Details on these Action Types / Methods are available below.
* '''Field List''' – is used to define which fields are retrievable through the function call.
==Configurations and Responses==
[[File:APIFunctionSample5l.PNG|800px]]
'''Sending API requests using cURL'''
cURL command below is an example on how to send API request to ''Get Metadata of a Universal Tracking Application'' using [https://curl.haxx.se/ cURL].
<pre><nowiki>curl -X GET -k -i 'https://api.smartsimple.com/API/1/levelone/</nowiki>
<nowiki>?url=https://api.smartsimple.com/API/1/levelone/</nowiki>
<nowiki>&companyid=825646</nowiki>
<nowiki>&alias=api</nowiki>
<nowiki>&username=dataimport@smartsimple.com</nowiki>
<nowiki>&password=********************</nowiki>
<nowiki>&apitoken=U2N4RwUBTn5XZldZXFdfWX1@C2JAWXVuAjIF'</nowiki></pre>
====Get Metadata of Organizations====
No parameters are needed to retrieve metadata.
Available in November 2018 Upgrade
====Get Metadata from Contacts====
<!--63342 - SmartConnect API - metadata option to include Orgs/Contacts-->
No parameters are needed to retrieve metadata.
Available in November 2018 Upgrade
===Report===
This function will retrieve the results of the query from an existing report by using the [[Determining_the_reportid|'''reportid''']].