SalesForceToFileSystem API 1

What is REST API ?

The REST API provide programmatic access to read and write application data. The REST API identifies the application and its users using OAUTH ; responses are available in json. We have used SWAGGER editor for the end users to make the API calls so that they can try out APIs exposed API management platform.

Click Here for accessing the CW-API management platform for unregistered user.

Checklist Before Getting Started

user should have the release of 4.2.9 or later .
A valid salesforce and FTP credentials

There are various API Methods list which are exposed for this release , we will be adding more methods in the upcoming releases .

SalesForceToFileSystem API

The SalesForceToFileSystem Api Code method is the actual API call used to invoke the Api Method so that the file from passed Salesforce objects gets downloaded to the assigned file path of the FTP server.

The below tables explains the various model schema and attributes which form the model class

SaleForceFile params

Parameter	Description	DataType
sfConfig (Optional)	The salesforce credentials which are required to connect to the salesforce instance	Salesforce
fsConfig (optional)	The FTP server credentials which are required to connect to FTP server for downloading a file	FTP
queryToTheAttachment (optional)	The salesfoce object to specify a file to be downloaded	String

Salesforce Params

Parameter	Description	DataType
username(Required)	The username of the salesforce instance from which the user wishes to retrieve information from where the file to be downloaded	string
password(Required)	The password of the salesforce instance	string
securityToken(Required)	A security Token is a case sensitive alpha numeric code that you append to the password or enter in a separate field in client application	string
sessionID(optional)	An Identifier for current user in the current context	string
endpointURL(Required)	The url to access the salesforce application	string

FileSystem Params

Parameter	Description	DataType
host(Required)	Hostname of ftp server	string
port(Required)	port number of ftp server	string
filesystemType	The possible supported FTP are Sftp, FTPS and plain FTP	string
username(Required)	ftp server username	string
password(Required)	ftp server password	string
folder(Required)	path within ftp server to place the file	string

Run Properties Params

Below table gives the attribute list of the response class

*Parameter*	*Description*	*Data type*
Status	The possible values are True and False which sends out the response value	String
SubmitTime	The API submitted time	Date
CompletionTime	The API Completion Time	Date
ProcessID	The process id which is sent by the API to identify the process	String
callbackURL	The url is passed from the API	string

Example For UnSucessful Download

Curl

curl -X POST --header 'Content-Type: application/json' --header
'Accept: application/json' -d '{"sfConfig":{"username":"","password":"","securityToken":"","sessionId":"","endpointURL":""},
"fsConfig":{"host":"","port":"","filesystemType":"","username":"","password":"","folder":""},"queryToTheAttachment":""}'
'https://api.mydbsync.com:443/api/appcode/v1/sftofilesystem/upsertFile'

Request URL

https://api.mydbsync.com:443/api/appcode/v1/sftofilesystem/upsertFile

Response Body

{
  "error": "AppCode:sftofilesystem does not exist, Please check your URL"
}

Response Code

Response Header

{
"date": "Mon, 20 Feb 2017 18:44:54 GMT",

"server": "Apache/2.4.25 (Amazon) OpenSSL/1.0.1k-fips",

"connection": "Keep-Alive",

"keep-alive": "timeout=5, max=100",

"content-length": "72",

"content-type": "application/json"

}

Page tree