DBSync Cloud Workflow (iPaaS)

2022

Page tree

Versions Compared

Old Version 3

changes.mady.by.user Anil Bhimineni

Saved on

compared with

New Version 4

changes.mady.by.user Anil Bhimineni

Saved on

Key

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

...

Title

SalesForceToFileSystem API

URL


The URL Structure (path only, no root url) is v1/sftofilesystem

  1. v1 changes whenever we the method is updated
  2. The user can access the relevant method call by entering appropriate version before the method name.


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 

{
  "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 below format 

{
  "sfConfig":  { 
 "username": "john@avankia.com",
 "password": "123456",
 "securityToken": "00P2800000lT3mq",
 "sessionId": "",
 "endpointURL": "https://ap2.salesforce.com/services/Soap/u/39.0" 
 },
   "targets": [ { 
    "host": "accounting.avankia.com", 
    "port": "21", 
    "filesystemType": "ftp", 
    "username": "anil.b@avankia.com", 
    "password": "123456", 
    "folder": "root", 
    "bucket": "string", 
    "targetFileName": "",
     "region": "" } 
 ],
  "queryToTheAttachment": "select Name,Body from attachment where id = '00P2800000lT3mq'" }


Success Response


The status code on Success reponse 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 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 :

<!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 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'


...