Using the Rest API

In this article, we will be using Curl to demonstrate the usage of the Rest API. You can use any preferred programming language or any tools as you like.
You may also want to directly interact with our online API using Swagger UI.

1. Generate a token

Once you have the userid and secret key, the first API need to be called is:
/gspLive_backend/user/generateToken
This API will return a temporary token that needs to be used in the API call thereafter.
SQLFlow Cloud Server
curl -X POST "https://api.gudusoft.com/gspLive_backend/user/generateToken" -H "Request-Origion:testClientDemo" -H "accept:application/json;charset=utf-8" -H "Content-Type:application/x-www-form-urlencoded;charset=UTF-8" -d "secretKey=YOUR SECRET KEY" -d "userId=YOUR USER ID HERE"
SQLFlow on-premise version
TOKEN is not needed in the on-premise version. So there is no need to generate any token.

2. Generate the data lineage

Call this API by sending the SQL query and get the result includes the data lineage.
/gspLive_backend/sqlflow/generation/sqlflow
SQLFlow Cloud Server
curl -X POST "https://api.gudusoft.com/gspLive_backend/sqlflow/generation/sqlflow?showRelationType=fdd" -H "Request-Origion:testClientDemo" -H "accept:application/json;charset=utf-8" -H "Content-Type:multipart/form-data" -F "sqlfile=" -F "dbvendor=dbvoracle" -F "ignoreRecordSet=false" -F "simpleOutput=false" -F "sqltext=CREATE VIEW vsal as select * from emp" -F "userId=YOUR USER ID HERE" -F "token=YOUR TOKEN HERE"
SQLFlow on-premise version
curl -X POST "http://127.0.0.1:8081/gspLive_backend/sqlflow/generation/sqlflow?showRelationType=fdd" -H "Request-Origion:testClientDemo" -H "accept:application/json;charset=utf-8" -H "Content-Type:multipart/form-data" -F "sqlfile=" -F "dbvendor=dbvoracle" -F "ignoreRecordSet=false" -F "simpleOutput=false" -F "sqltext=CREATE VIEW vsal as select * from emp" -F "userId=gudu|0123456789"

3. Export the data lineage in csv format

Call this API by sending the SQL file and get the csv result includes the data lineage.
/gspLive_backend/sqlflow/generation/sqlflow/exportLineageAsCsv
curl -X POST "https://api.gudusoft.com/gspLive_backend/sqlflow/generation/sqlflow/exportLineageAsCsv" -H "accept:application/json;charset=utf-8" -H "Content-Type:multipart/form-data" -F "userId=YOUR USER ID HERE" -F "token=YOUR TOKEN HERE" -F "dbvendor=dbvoracle" -F "showRelationType=fdd" -F "[email protected] UPLOAD FILE PATH HERE" --output YOUR DOWNLOAD FILE PATH HERE
Sample:
curl -X POST "https://api.gudusoft.com/gspLive_backend/sqlflow/generation/sqlflow/exportLineageAsCsv" -H "accept:application/json;charset=utf-8" -H "Content-Type:multipart/form-data" -F "userId=auth0|5fc8e95991a780006f180d4d" -F "token=YOUR TOKEN HERE" -F "dbvendor=dbvoracle" -F "showRelationType=fdd" -F "[email protected]:\prg\tmp\demo.sql" --output c:\prg\tmp\demo.csv
Note:
  • -H "Content-Type:multipart/form-data" is required.
  • Add @ before the upload file path
  • --output is required.
  • Optional, if you just want to fetch table to table relations, please add -F "tableToTable=true"

4. Submit multiple SQL files and get the data lineage in CSV, JSON, graphml format.

The full reference to the Rest APIs

Troubleshooting

  • Under windows, you may need to add option --ssl-no-revoke to avoid some security issues, curl --ssl-no-revoke