Skip to main content

RightData (DataTrust) Rest API with Token

This document explains how to create an API Token and manage it. You can create an API token for individual Scenarios/Queries/Jobs. Creating an API token makes it easier to share the scenarios across different platforms.

 

RightData (DataTrust) rest API is used for invoking the application processes from the below:

  • External job scheduling tools like Autosys, Control-M, JAMS, etc.
    • Integrate RightData (DataTrust) processes as part of the enterprise batch scheduling
  • ETL like: Talend, Informatica, etc
    • Trigger RightData (DataTrust) validation process after or in between ETL pipeline
  • CICD/DevOps tools like Jenkins, Bitbucket, etc.
    • Integrate RightData (DataTrust) as part of automatic deployment and automatic testing

Steps To Create the API Token:

  • Select the scenario from the Scenario Studio/Query Studio/Batch Console.
  • Click on the Generate RD Service Button on top.
2022-08-11_12-48-10.png
  • The following screen will appear once you select the scenario and click on the button.

The service URL tab lists down 3 different URL’s:

  • The first URL is the Rest API to execute the scenario.
  • The second URL gives you the status of execution for the scenario.
  • The third URL gives you an option to pass parameters if any in the scenario.

Introduced a new parameter in Post method RESTAPI for Validation, FDR and Batch Jobs to override original file path when a remote CSV (only for remote files) is used as source/target. Click here for more details

2022-08-11_12-49-00.png
  • You also have an Additional Setting option where you can set the expiry date for the token.
  • After filling in the date always ensure to click on Save and Close button so that the token gets created. If you don’t save, it will show an error when you try to execute.
2022-08-11_12-51-25.png
  • A 'Token Saved successfully' toaster message is displayed.
2022-08-11_12-52-20.png
  • Go to the 'ADMIN CONSOLE' module.
  • Click the 'System Preferences' option.
2022-08-11_12-52-54.png
  • This action pops up 'Preferences' window.
  • Click the 'API Tokens' tile.
2022-08-11_12-53-32.png
  • An 'API Tokens' session page is displayed.
  • The generated token (BDV) is displayed here.
2022-08-11_12-54-21.png

 

From the populated list, you can select any token and modify it. The API description consists of -

  • Scenario Type- The scenario type can be an FDR, TDR, validation, or bulk validation scenario. It can be a query or query chain. It can also be a job. You can see the different symbols for the respective type in that column.
  • Scenario Name – It gives us the name of the scenario for which the token is created.
  • API - It gives us the URL of the API token.
  • Expiry Date – It gives us the expiry date when the token expires.
  • Status - It shows you the present status of the scenario.
  • Created By – It gives you the name of the user who created it.
  • Created On - It gives us the date and time when the token was created.
  • Modified By - It gives us the name of the user who last modified it.
  • Modified On - It gives us the date and time when the token was last modified.

You can also see a list of options available to modify the token in the left corner.

Note: Select and checkbox any Scenario to perform any function.

2022-08-11_12-55-25.png
  • The first option is ‘Copy’ with which you can directly copy the URL of the token.
  • The second option is ‘Change Expiry Date’ with which you can reset the expiry date of the token.
2022-08-11_12-56-30.png
  • The third option is ‘Activate’ with which you can activate any token you want.
  • The fourth option is ‘De-Activate’ with which you can de-activate any token. Once you use this option the token gets de-activated instantly irrespective of any other setting made for that token.
  • The fifth option is ‘History’ where you can see the history of the number of times the token was executed.
2022-08-11_12-57-54.png

In the above window, you get three columns-

      • The first column consists of the ‘copy’ option, so you can copy the result. You can even sort the execution history in ascending or descending order.
      • The second column shows the Execution Result.
      • The third column shows the date and time when the execution took place.
  • The sixth option is ‘Re-generate’ with which you can regenerate any existing token. When you regenerate a token, all previous instances of that token become inactive. Now only the regenerated version of the token can be used.
2022-08-11_12-58-42.png
  • The above window shows you the detail of the token before you regenerate it. Once you click on the Re-Generate button the following screen will appear.
Was this article helpful?