Smartstaff
1,385
edits
Changes
no edit summary
'''Field List''' - companies.*
No parameters are needed to retrieve metadata.
[[File:APIFunctionGetOrgMeta.PNG|800px]]
====Get Metadata from Contacts====
<!--63342 - SmartConnect API - metadata option to include Orgs/Contacts-->
'''Action Type ''' - Download File<br />
'''Field List''' -
'''Mandatory fields''' to download a file:<br/>
filename - name of the file to be downloaded.<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]
[[File:APIFunctionDownloadFile1.PNG|800px]]
====Upload File(s) to a field in the company profile====<!--122516 - API file upload-->'''Function Name''' - 3.06.2 Upload File Method Sample 1: Upload file(s) to an existing company record<br />'''Description''' - Upload the file based on the criteria indicated.<br />'''Object Type''' - Company<br />'''Action Type ''' - Upload Files<br />'''Field List''' - cf_123456 '''Mandatory fields''' to upload a file:<br />objectid - is the [wiki/Determining_the_companyid Company ID] where the file is attached to.<br />fieldid - [wiki/Custom_Field_ID Custom Field ID] of the Organization record that is either a [wiki/Custom_Field_Type:_Upload_-_Single_File_Storage single file type] or [wiki/Custom_Field_Type:_Upload_-_Multiple_Files_Storage multiple file type]. --Begin custom parameter --<br />objectid: 1688407<br />fieldid: 1523157<br />--End custom parameter--
<br />Note: To test use Postman. the API URL for upload file will be:
https://alias.smartsimple.com/API/1/company/?alias=xxxxx&companyid=xxxxxx&username=xxxxx&password=xxxxx&apitoken=xxxxx&objectid=xxxxx&fieldid=xxxxx<br />with the file included in the form data, use POST method.
===Search File===
This function will retrieve a list of files by searching for a keyword.