DBSync Cloud Workflow (iPaaS)

2022

Page tree

Versions Compared

Old Version 3

changes.mady.by.user Anil Bhimineni

Saved on

compared with

New Version Current

changes.mady.by.user Munira Majumdar

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Checklist 

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. 

  1. User should have the release of 4.2.9 or later .
  2. A valid Salesforce and FTP credentials credentials. 

SalesForceToFileSystem API

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.

  1. v1 changes whenever we the method is updatedthe hosted environment of APIServer changes.
  2. The user can access the relevant method call by entering appropriate version before the method's name.


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:

{


"sfConfig":

{

"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"


}

],


"queryToTheAttachment":

"string"


}

Example

As the SalesForceToFileSystem is a post request, The body payload should be in format below format :

{


"sfConfig":

{


"username":

"john@avankia.com",

"password":

"123456",

"securityToken":

"

00P2800000lT3mq

fbEw74CxeC8kcxLK2zUnAlcp3",

"sessionId":

"",

"endpointURL":

"https://ap2.salesforce.com/services/Soap/u/39.0"


},

"targets":

[

{


"host":

"

accounting

account.avankia.com",


"port":

"21",


"filesystemType":

"ftp",


"username":

"anil.b@avankia.com",


"password":

"123456",


"folder":

"

root

testFiles",


"bucket":

"string",


"targetFileName":

""

,


"region":

""


}

],


"queryToTheAttachment":

"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 :

[
{
"id": "testFiles/SanAntonio Queries After TriggerSampledata.txt",
"newid": "testFiles/SanAntonio Queries After TriggerSampledata.txt",
"success": true,
"errors": [null]
}
]


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 :

<!DOCTYPE html><html><head><title>Apache Tomcat/8.0.41 - 
Error report</title><style type="text/css">H1 
{font-family:Tahoma,Arial,sans-serif;color:white;background-color:#525D76;font-size:22px;} 
H2 {font-family:Tahoma,Arial,sans-serif;color:white;background-color:#525D76;font-size:16px;} 
H3 {font-family:Tahoma,Arial,sans-serif;color:white;background-color:#525D76;font-size:14px;}
BODY {font-family:Tahoma,Arial,sans-serif;color:black;background-color:white;}
B {font-family:Tahoma,Arial,sans-serif;color:white;background-color:#525D76;} 
P {font-family:Tahoma,Arial,sans-serif;background:white;color:black;font-size:12px;}
A {color : black;}A.name {color : black;}.line {height: 1px; background-color: #525D76; border: none;
} </style> </head><body><h1>HTTP Status 403 - Invalid CSRF Token 'null' was found on the request parameter '_csrf' or header 'X-CSRF-TOKEN'.</h1><div class="line"></div><p><b>type</b> Status report</p><p><b>message</b> <u>Invalid CSRF Token 'null' was found on the request parameter '_csrf' or header 'X-CSRF-TOKEN'.</u></p><p><b>description</b> <u>Access to the specified resource has been forbidden.</u></p><hr class="line"><h3>Apache Tomcat/8.0.41</h3></body></html>
Sample CallThe below is the sample call from the endpoint. This would make the API call more predictable for the

[
{
"success": false,
"errors : [ "INVALID_LOGIN: Invalid username, password, security token; or user locked out."]
}
]



Sample Call


Below is a sample call from the endpoint. This would make the API call more predictable to the reader.


curl -X POST --header 'Content-Type: application/json' --header 'Accept: text/html' -d '

{


"sfConfig":{

{

"username":"

anil

john@avankia.

b@avankia.

com",
"password":"

@Raman123

@test123",
"securityToken":"fbEw74CxeC8kcxLK2zUnAlcp3",
"sessionId":"https://ap2.salesforce.com/services/Soap/u/39.0",
"endpointURL":"string"},
"targets":[{
"host":"

107

account.

180

avankia.

12.172

com","port":"21",
"filesystemType":"ftp",
"username":"

dbsyncftp@hrnewspad

anil.b@avankia.com",
"password":"

AvankiaFTP789()

123456",
"folder":"testFiles",
"bucket":"",
"targetFileName":"",
"region":""
}],
"queryToTheAttachment":"select

Name,Body

from

attachment

where

id

= \u002700P2800000lT3mq\u0027"

= '00P2800000lT3mq"


}'


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