Skip to main content

CLEO Portal (Integration Cloud) for SFTP - Rest API Transfer

By Dinesh

 

This blog details about using CLEO REST API to transfer file(s) between SFTP. 

  • Normally, people utilize SFTP/ FTP protocol to connect to server. 
  • But, if server is integrated with CLEO Portal then one can make use of CLEO HTTP(s) Rest API to transfer file as following - 


  • GENERATE AUTHORIZATION TOKEN USING USERNAME & PASSWORD 

curl -X POST https://YOURTENANT.cleointegration.com/api/authentication  -H 'content-type: application/x-www-form-urlencoded' -d 'grant_type=password&username=USERNAME&password=PASSWORD&totp_code=undefined'


Above Curl invocation will return a JSON Message with access Token that should be passed as header Authorization : Bearer *  for future invocation to API.

{
   "token_type":"bearer",
   "access_token":"eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJrdXFiMDNXTlEtYVZra1lRWGlSa1RBIiwiY3ljbGVJZCI6IkYiLCJpc3MiOiJodHRwOlwvXC93d3cuY2xlby5jb20iLCJvbW5pSWQiOiJrdXFiMDNXTlEtYVZra1lRWGlSa1RBIiwiZXhwIjoxNjc0MDkwNTU5LCJpYXQiOjE2NzQwODY5NTksIkFjY2Vzc1R5cGUiOiJERUZBVUxUIn0.QEpb27LZOj71vocJdYJPN7zxgF_LcwfUbQY7sDB6rwE",
   "user_id":"kuqb03WNQ-aVkkYQXiRkTA"
}
  • TO LIST HOME FOLDER USE BELOW CURL COMMAND - 
curl -X GET -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJrdXFiMDNXTlEtYVZra1lRWGlSa1RBIiwiY3ljbGVJZCI6IkYiLCJpc3MiOiJodHRwOlwvXC93d3cuY2xlby5jb20iLCJvbW5pSWQiOiJrdXFiMDNXTlEtYVZra1lRWGlSa1RBIiwiZXhwIjoxNjc0MDkwNTU5LCJpYXQiOjE2NzQwODY5NTksIkFjY2Vzc1R5cGUiOiJERUZBVUxUIn0.QEpb27LZOj71vocJdYJPN7zxgF_LcwfUbQY7sDB6rwE' https://YOURTENANT.cleointegration.com/api/folders

This will return JSON message describing home folder id and permissions - 

{"totalResults":1,"startIndex":0,"count":1,"resources":[{"type":"folder","space":"home","id":"OGI5N2IyMjA4ODU2MmI0NzFmODcxNWViNjVhMTFiNDlhYTk5M2QyMmU0ZjE3MWY2NTEyYmQzNzlmYTQyMDE3MA","name":"USERNAME","permissions":["subdirs","download","upload"],"systemProtected":{"delete":true,"rename":true},"_links":{"self":{"href":"/api/folders/OGI5N2IyMjA4ODU2MmI0NzFmODcxNWViNjVhMTFiNDlhYTk5M2QyMmU0ZjE3MWY2NTEyYmQzNzlmYTQyMDE3MA"}},"meta":{"lastModified":"2023-01-18T23:32:38.421Z"}}]}

  • USE BELOW CURL COMMAND TO LIST CHILDREN'S UNDER HOME FOLDER - 
curl -X GET -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJrdXFiMDNXTlEtYVZra1lRWGlSa1RBIiwiY3ljbGVJZCI6IkYiLCJpc3MiOiJodHRwOlwvXC93d3cuY2xlby5jb20iLCJvbW5pSWQiOiJrdXFiMDNXTlEtYVZra1lRWGlSa1RBIiwiZXhwIjoxNjc0MDkwNTU5LCJpYXQiOjE2NzQwODY5NTksIkFjY2Vzc1R5cGUiOiJERUZBVUxUIn0.QEpb27LZOj71vocJdYJPN7zxgF_LcwfUbQY7sDB6rwE' https://YOURTENANT.cleointegration.com/api/folders/OGI5N2IyMjA4ODU2MmI0NzFmODcxNWViNjVhMTFiNDlhYTk5M2QyMmU0ZjE3MWY2NTEyYmQzNzlmYTQyMDE3MA/children

This will return child folders and files under home 

{"totalResults":5,"startIndex":0,"count":5,"resources":[{"type":"folder","space":"home","id":"OGI5N2IyMjA4ODU2MmI0NzFmODcxNWViNjVhMTFiNDlhNDAzZjgwN2E1N2JlNDU5NTA1NTY2NmM4Yzg5MmYxOGUyOTVhMDU3Zjk5ZjRlYTY1MTU1OTNjNDEyZTkyODE0","name":"inprogress","permissions":["subdirs","download","upload","delete"],"systemProtected":{"delete":false,"rename":false},"_links":{"self":{"href":"/api/folders/OGI5N2IyMjA4ODU2MmI0NzFmODcxNWViNjVhMTFiNDlhNDAzZjgwN2E1N2JlNDU5NTA1NTY2NmM4Yzg5MmYxOGUyOTVhMDU3Zjk5ZjRlYTY1MTU1OTNjNDEyZTkyODE0"}},"meta":{"lastModified":"2023-01-17T19:34:19.947Z"}},{"type":"folder","space":"home","id":"OGI5N2IyMjA4ODU2MmI0NzFmODcxNWViNjVhMTFiNDk1MmFmYWVhNDMxOGY2MzE3MGJlYTdhYmUxOGJkNjhlOGFhNTJlYjE4MWU5ZWFhMjI5MGU4ZDc5M2RlZTVhMjQ3","name":"processed","permissions":["subdirs","download","upload","delete"],"systemProtected":{"delete":false,"rename":false},"_links":{"self":{"href":"/api/folders/OGI5N2IyMjA4ODU2MmI0NzFmODcxNWViNjVhMTFiNDk1MmFmYWVhNDMxOGY2MzE3MGJlYTdhYmUxOGJkNjhlOGFhNTJlYjE4MWU5ZWFhMjI5MGU4ZDc5M2RlZTVhMjQ3"}},"meta":{"lastModified":"2023-01-17T19:34:54.402Z"}},{"type":"folder","space":"home","id":"OGI5N2IyMjA4ODU2MmI0NzFmODcxNWViNjVhMTFiNDk5NDc5MGMzMjI0ZDQwODFlYzE3OGY0MGM1NWQ3ZjM3NmM1NjdjYjU0N2RiMzBjMzhlNzQ3MjQ1YzFmZTU0MzBi","name":"SPS_daily_transaction","permissions":["subdirs","download","upload","delete"],"systemProtected":{"delete":true,"rename":true},"_links":{"self":{"href":"/api/folders/OGI5N2IyMjA4ODU2MmI0NzFmODcxNWViNjVhMTFiNDk5NDc5MGMzMjI0ZDQwODFlYzE3OGY0MGM1NWQ3ZjM3NmM1NjdjYjU0N2RiMzBjMzhlNzQ3MjQ1YzFmZTU0MzBi"}},"meta":{"lastModified":"2023-01-12T19:53:57.659Z"}},{"type":"folder","space":"home","id":"OGI5N2IyMjA4ODU2MmI0NzFmODcxNWViNjVhMTFiNDk1ZjNiYjhhMGYyYjkyMDBmOGQ5NTZkOTEwNGQzNmJkYTVlNGFmNDVhODk2YTNjMTgxMDZkM2EzMTVkYTgwMjk5","name":"SPS_recurring_payment","permissions":["subdirs","download","upload","delete"],"systemProtected":{"delete":true,"rename":true},"_links":{"self":{"href":"/api/folders/OGI5N2IyMjA4ODU2MmI0NzFmODcxNWViNjVhMTFiNDk1ZjNiYjhhMGYyYjkyMDBmOGQ5NTZkOTEwNGQzNmJkYTVlNGFmNDVhODk2YTNjMTgxMDZkM2EzMTVkYTgwMjk5"}},"meta":{"lastModified":"2023-01-12T19:53:57.669Z"}},{"type":"file","space":"home","id":"OGI5N2IyMjA4ODU2MmI0NzFmODcxNWViNjVhMTFiNDk4ZGNjZDBkNGY0NzMzMzVmMTZkNWRlMmFjMmIwOWM0MDc5NDYwZWY1YzRjYzM3ZTdmYjQ5NDBjMmM2NTBkMDBm","name":"test.py","length":741,"permissions":["download","delete","overwrite"],"systemProtected":{"delete":false,"rename":false},"_links":{"self":{"href":"/api/files/OGI5N2IyMjA4ODU2MmI0NzFmODcxNWViNjVhMTFiNDk4ZGNjZDBkNGY0NzMzMzVmMTZkNWRlMmFjMmIwOWM0MDc5NDYwZWY1YzRjYzM3ZTdmYjQ5NDBjMmM2NTBkMDBm"}},"meta":{"lastModified":"2023-01-18T23:32:38.426Z"}}]}

  • USE FOLLOWING CURL COMMAND TO DOWNLOAD FILE "TEST.PY" - 
curl -o test.py -X GET -d'access_token=eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJrdXFiMDNXTlEtYVZra1lRWGlSa1RBIiwiY3ljbGVJZCI6IkYiLCJpc3MiOiJodHRwOlwvXC93d3cuY2xlby5jb20iLCJvbW5pSWQiOiJrdXFiMDNXTlEtYVZra1lRWGlSa1RBIiwiZXhwIjoxNjc0MDkwNTU5LCJpYXQiOjE2NzQwODY5NTksIkFjY2Vzc1R5cGUiOiJERUZBVUxUIn0.QEpb27LZOj71vocJdYJPN7zxgF_LcwfUbQY7sDB6rwE' https://YOURTENANT.cleointegration.com/api/files/OGI5N2IyMjA4ODU2MmI0NzFmODcxNWViNjVhMTFiNDk4ZGNjZDBkNGY0NzMzMzVmMTZkNWRlMmFjMmIwOWM0MDc5NDYwZWY1YzRjYzM3ZTdmYjQ5NDBjMmM2NTBkMDBm


Refer following URL for Upload file instructions - https://www.cleo.com/blog/sending-data-to-cleo-integration-cloud

Comments

Post a Comment

Popular posts

Hive Parse JSON with Array Columns and Explode it in to Multiple rows.

By Dinesh
 Say we have a JSON String like below -  { "billingCountry":"US" "orderItems":[       {          "itemId":1,          "product":"D1"       },   {          "itemId":2,          "product":"D2"       }    ] } And, our aim is to get output parsed like below -  itemId product 1 D1 2 D2   First, We can parse JSON as follows to get JSON String get_json_object(value, '$.orderItems.itemId') as itemId get_json_object(value, '$.orderItems.product') as product Second, Above will result String value like "[1,2]". We want to convert it to Array as follows - split(regexp_extract(get_json_object(value, '$.orderItems.itemId'),'^\\["(.*)\\"]$',1),'","') as itemId split(regexp_extract(get_json_object(value, '$.orderItems.product'),'^\\["(.*)\\"]$',1),...
Post a Comment
Read more




org.apache.spark.sql.AnalysisException: Cannot overwrite a path that is also being read from.;

By Dinesh
  Caused by: org.apache.spark.sql.AnalysisException: Cannot overwrite a path that is also being read from.; at org.apache.spark.sql.execution.command.DDLUtils$.verifyNotReadPath(ddl.scala:906) at org.apache.spark.sql.execution.datasources.DataSourceAnalysis$$anonfun$apply$1.applyOrElse(DataSourceStrategy.scala:192) at org.apache.spark.sql.execution.datasources.DataSourceAnalysis$$anonfun$apply$1.applyOrElse(DataSourceStrategy.scala:134) at org.apache.spark.sql.catalyst.trees.TreeNode$$anonfun$2.apply(TreeNode.scala:267) at org.apache.spark.sql.catalyst.trees.TreeNode$$anonfun$2.apply(TreeNode.scala:267) at org.apache.spark.sql.catalyst.trees.CurrentOrigin$.withOrigin(TreeNode.scala:70) at org.apache.spark.sql.catalyst.trees.TreeNode.transformDown(TreeNode.scala:266) at org.apache.spark.sql.catalyst.trees.TreeNode.transform(TreeNode.scala:256) at org.apache.spark.sql.execution.datasources.DataSourceAnalysis.apply(DataSourceStrategy.scala:134) at org.apache.spark.sql.execution.dataso...
Post a Comment
Read more




Read from a hive table and write back to it using spark sql

By Dinesh
In context to Spark 2.2 - if we read from an hive table and write to same, we get following exception- scala > dy . write . mode ( "overwrite" ). insertInto ( "incremental.test2" ) org . apache . spark . sql . AnalysisException : Cannot insert overwrite into table that is also being read from .; org . apache . spark . sql . AnalysisException : Cannot insert overwrite into table that is also being read from .; 1. This error means that our process is reading from same table and writing to same table. 2. Normally, this should work as process writes to directory .hiveStaging... 3. This error occurs in case of saveAsTable method, as it overwrites entire table instead of individual partitions. 4. This error should not occur with insertInto method, as it overwrites partitions not the table. 5. A reason why this happening is because Hive table has following Spark TBLProperties in its definition. This problem will solve for insertInto met...
Post a Comment
Read more




Hadoop Distcp Error Duplicate files in input path

By Dinesh
  One may face following error while copying data from one cluster to other, using Distcp  Command: hadoop distcp -i {src} {tgt} Error: org.apache.hadoop.toolsCopyListing$DulicateFileException: File would cause duplicates. Ideally there can't be same file names. So, what might be happening in your case is you trying to copy partitioned table from one cluster to other. And, 2 different named partitions have same file name. Your solution is to correct Source path  {src}  in your command, such that you provide path uptil partitioned sub directory, not the file. For ex - Refer below : /a/partcol=1/file1.txt /a/partcol=2/file1.txt If you use  {src}  as  "/a/*/*"  then you will get the error  "File would cause duplicates." But, if you use  {src}  as  "/a"  then you will not get error in copying.
Post a Comment
Read more




Scala Spark building Jar leads java.lang.StackOverflowError

By Dinesh
  Exception -  [Thread-3] ERROR scala_maven.ScalaCompileMojo - error: java.lang.StackOverflowError [Thread-3] INFO scala_maven.ScalaCompileMojo - at scala.collection.generic.TraversableForwarder$class.isEmpty(TraversableForwarder.scala:36) [Thread-3] INFO scala_maven.ScalaCompileMojo - at scala.collection.mutable.ListBuffer.isEmpty(ListBuffer.scala:45) [Thread-3] INFO scala_maven.ScalaCompileMojo - at scala.collection.mutable.ListBuffer.toList(ListBuffer.scala:306) [Thread-3] INFO scala_maven.ScalaCompileMojo - at scala.collection.mutable.ListBuffer.result(ListBuffer.scala:300) [Thread-3] INFO scala_maven.ScalaCompileMojo - at scala.collection.mutable.Stack$StackBuilder.result(Stack.scala:31) [Thread-3] INFO scala_maven.ScalaCompileMojo - at scala.collection.mutable.Stack$StackBuilder.result(Stack.scala:27) [Thread-3] INFO scala_maven.ScalaCompileMojo - at scala.collection.generic.GenericCompanion.apply(GenericCompanion.scala:50) [Thread-3] INFO scala_maven.ScalaCompile...
Post a Comment
Read more