2022
...
There are various only few API Methods list which that are exposed for in this release , we . We will be adding more methods in the upcoming releases.
The SalesForceToFileSystem Api Code method method is the actual API call used to invoke the Api API Method so that the file from passed previous Salesforce objects gets downloaded to to the assigned file path of the FTP server. In order for This will enable an unregistered user to access this API method.
Click on SFToFTP url to try out the method
Title | SalesForceToFileSystem API |
---|---|
URL | The URL Structure structure (path only, no root url) is v1/sftofilesystem.
|
Method | The Request request type is POST. |
URL Params | N/A |
Data Params | As the SalesForceToFileSystem is a post request, The the body payload should be in below the following format: {
{ "username": "string", "password": "string", "securityToken": "string", "sessionId": "string", "endpointURL": "string" }, "targets": [ { "host": "string", "port": "string", "filesystemType": "string", "username": "string", "password": "string", "folder": "string", "bucket": "string", "targetFileName": "string", "region": "string"
],
"string"
Example As the SalesForceToFileSystem is a post request, The body payload should be in format below format : {
{ "username": "john@avankia.com", "password": "123456", "securityToken": " 00P2800000lT3mqfbEw74CxeC8kcxLK2zUnAlcp3", "sessionId": "", "endpointURL": "https://ap2.salesforce.com/services/Soap/u/39.0" }, "targets": [ { "host": " accountingaccount.avankia.com", "port": "21", "filesystemType": "ftp", "username": "anil.b@avankia.com", "password": "123456", "folder": " roottestFiles", "bucket": "string", "targetFileName": "" ,"region": ""
],
"select Name,Body from attachment where id = '00P2800000lT3mq'"
|
Success Response | The status code on Success reponse success response should be 200. Example Code : 200 Response Body : [ |
Error Response | Most endpoint will have Endpoint may fail in many ways they can fail. Below are some of the known error reponse response code and response body. Code 401 : Unautorized Unauthorized access Code 403 : Forbidden error Example Code : 403401 Response Body : [ |
Sample Call | The below Below is the a sample call from the endpoint. This would make the API call more predictable for to the reader. curl -X POST --header 'Content-Type: application/json' --header 'Accept: text/html' -d ' {
"username":" aniljohn@avankia. b@avankia.com", @test123", account. 180avankia. 12.172com","port":"21", anil.b@avankia.com", 123456", Name,Body from attachment where id = \u002700P2800000lT3mq\u0027"= '00P2800000lT3mq"
|