REST API simplifies your interaction with the data stored on
Talend Dictionary Service by using a number of
methods or request types.
You can access all REST API documentation pages based on Swagger and run
requests. You can also download a JSON file from any of the REST API documentation
pages.
Before you begin
You must have installed and configured Talend Dictionary Service correctly while installing
Talend Data Stewardship or Talend Data Preparation.
You have logged in to Talend Data Stewardship or Talend Data Preparation.
Procedure
-
Start all the modules in the Talend Data Stewardship or
Talend Data Preparation installation folder depending on
which application you want to access the documentation from.
Note: To
access Talend Dictionary Service REST API
from Talend Data Preparation, you must
first set the value of the service.documentation
parameter to true
in the <Installation_Path>/dataprep/config/application.properties
configuration file.
-
Open a web browser and enter the following URL where
<host>
and <port>
depend on your installation:
http://<host>:<port>/docs/api/swagger-ui.html
-
Open a Web browser and enter the following URI: https://tds.{region}.cloud.talend.com/docs/api/swagger-ui.html.
-
From the field on top of the page, select Semantic Service to open the Talend Dictionary Service documentation page where
operations are classified into different categories.
Example
-
Click a category name to display the operation list under the category.
-
Click and use your credentials to log in.
In the Response Headers area, you get a bearer
authentication.
-
Start testing the execution of different operations.
To get results from the executed operations, use the Curl command from the
response.
Include the bearer token you got when you logged in as part of your
authorization header.
Example
curl -X GET --header 'Authorization: Bearer <token>' --header 'Accept: application/json' 'http://<host>:<port>/categories?caseSensitive=false&isExact=false'