Usage scenario

• upload code, see status and get result directly with HTTP
• user is autenticated by basic HTTP authentication

Create batch with souce codes

• create .zip archive containing SQL source codes and Input Description JSON
• You may download .zip samples from public dir on Application page and adjust according your needs

Upload batch to server

• upload to http://www.dalineage.com/api/upload using Basic HTTP Authorization

export SERVER=http://www.dalineage.com/
export FILE=myfile.zip
curl -k -u myuser:mypassword -X POST -H "Content-type: application/zip" $SERVER/api/upload -T $FILE

• if upload succeeds, you get Batch ID

Check processing status

• check status

export SERVER=http://www.dalineage.com/
curl -k -u myuser:mypassword -X GET -H "Accept: application/json" $SERVER/api/status/{user}/{batch_id}

There are 5 possible status:

• waiting - processing has not been started yet
• running - processing is in progress
• completed - processing has been completed successfully
• failed - processing has been completed with error
• unknown - unknown status, if no state from above has been detected

Delete batch

• delete batch by batchId

export SERVER=http://www.dalineage.com/
curl -k -u myuser:mypassword -X DELETE "$SERVER/api/batch/{user}/{batch_id}?permanent=true"

Use permanent query parameter to delete batch permanently or move it into deleted director.

• permanent=true - delete batch permanently
• permanent=false [default] - move batch into deleted directory

See visualization

• go to http://www.dalineage.com/, login and browse processed batches see Glossary for visualization details"

Swagger

Try the REST API using Swagger