2022
...
Click on SFToFTP url to try out the method
Title | SalesForceToFileSystem API |
---|---|
URL | The URL Structure (path only, no root url) is v1/sftofilesystem
|
Method | The Request type is POST |
URL Params | N/A |
Data Params | As the SalesForceToFileSystem is a post request, The body payload should be in below format
"username": "string", "password": "string", "securityToken": "string", "sessionId": "string", "endpointURL": "string" },
"host": "string", "port": "string", "filesystemType": "string", "username": "string", "password": "string", "folder": "string", "bucket": "string", "targetFileName": "string", "region": "string" }
Example As the SalesForceToFileSystem is a post request, The body payload should be in below format
"username": "john@avankia.com", "password": "123456", "securityToken": "00P2800000lT3mq", "sessionId": "", "endpointURL": "https://ap2.salesforce.com/services/Soap/u/39.0" },
"host": "accounting.avankia.com", "port": "21", "filesystemType": "ftp", "username": "anil.b@avankia.com", "password": "123456", "folder": "root", "bucket": "string", "targetFileName": "", "region": "" }
|
Success Response | The status code on Success reponse should be 200. Example Code : 200 Response Body : [ |
Error Response | Most endpoint will have many ways they can fail. Below are some of the known error reponse code and response body. Code 401 : Unautorized access Code 403 : Forbidden error Example Code : 403 Response Body :
|
Sample Call | The below is the sample call from the endpoint. This would make the API call more predictable for the |
reader. curl -X POST --header 'Content-Type: application/json' --header 'Accept: text/html' -d ' {"sfConfig": {"username":"anil.b@avankia.com", "password":"@Raman123", "securityToken":"fbEw74CxeC8kcxLK2zUnAlcp3", "sessionId":"https://ap2.salesforce.com/services/Soap/u/39.0", "endpointURL":"string"}, "targets":[{"host":"107.180.12.172","port":"21", "filesystemType":"ftp", "username":"dbsyncftp@hrnewspad.com", "password":"AvankiaFTP789()", "folder":"testFiles", "bucket":"", "targetFileName":"", "region":""}], "queryToTheAttachment":"select Name,Body from attachment where id = \u002700P2800000lT3mq\u0027"}' 'https://api.mydbsync.com:443/api/appcode/v1/sftofilesystem/upsertFile' |