Smartstaff
1,385
edits
Changes
no edit summary
===Get===
This function will retrieve all fields from the '''Field List''' of a single record based on the '''recordid''' of an '''Object Type'''.
====Retrieve a Single Organization Record====
'''Function Name''' - 3.01.1 Get Method Sample 1: Retrieve a Single Organization Record<br />
'''Description''' - This function will retrieve a single record from the organization using the recordid: [[Determining_the_companyid|Company ID]]. The function is set up to retrieve the fields listed under '''Field List'''.<br />
'''Object Type''' - Company<br />
'''Action Type ''' - Get<br />
===Report===
This function will retrieve the results of the query from an existing report by using the '''reportid'''.
====Report Query====
<!--71845 - SmartConnect Function - Report-Query doesn't show the data-->
'''Function Name''' - 3.02.1 Get Report Sample 1: Report Query<br />
'''Description''' - To retrieve data from a report.<br />
'''Action Type ''' - Query<br />
'''Field List''' -
'''Mandatory field''':<br/>
'''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".
=====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 />
===List===
This function will retrieve a list of records from the selected '''Object Type'''. Records will include all fields from the '''Field List''' and can be filtered using the parameter '''criteria''' and can also be sorted out using the parameter '''sortby'''.
====List====
=====Retrieve a list of contacts=====
[[File:APIFunctionSample5k.PNG|800px]]
==='Metadata'===
====Get Metadata of a Universal Tracking Application====
'''Function Name''' - 3.04.1 Get Metadata Sample 1: CMS360°: Application Metadata<br />
'''Action Type ''' - Download File<br />
'''Field List''' -
'''Mandatory fields''' to download a file:<br/>
filename - name of the file to be downloaded.<br/>
===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
====Variables Replace - Company====
====Variables Replace - User====