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.
==Sending API requests using cURL==
cURL command below is an example on how to send Metadata API SmartSimple Function using [https://curl.haxx.se/ cURL].
<nowiki>curl -X GET -k -i 'https://api.smartsimple.com/API/1/levelone/</nowiki><br/>
<nowiki>?url=https://api.smartsimple.com/API/1/levelone/</nowiki><br/>
<nowiki>&companyid=825646</nowiki><br/>
<nowiki>&alias=api</nowiki><br/>
<nowiki>&username=dataimport@smartsimple.com</nowiki><br/>
<nowiki>&password=********************</nowiki><br/>
<nowiki>&apitoken=U2N4RwUBTn5XZldZXFdfWX1@C2JAWXVuAjIF'</nowiki><br/>
==Configurations and Responses==
'''Object Type''' - Company<br />
'''Action Type ''' - Get Meta<br />
'''Field List''' - companies.*<br /> No parameters are needed to retrieve metadata.<br />
Available in November 2018 Upgrade
'''Object Type''' - User<br />
'''Action Type ''' - Get Meta<br />
'''Field List''' - contacts.*<br /> No parameters are needed to retrieve metadata.<br />
Available in November 2018 Upgrade
'''reportid''' - is the [[Determining the reportid|Report ID]] of the [[Report|report]] in the instance.<br/>
'''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".<br/>
=====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 />