REST API simplifies your interaction with the data stored on the
Talend Data Preparation server 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 download a JSON file from any of the REST API
documentation pages.
Procedure
-
Launch all the modules in the Talend Data Preparation
installation folder.
Note: To access Talend Data Preparation
REST API, 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 window and enter the following URL, where
host and port correspond to the URL of your Talend Data Preparation instance:
https://<host>:<port>/swagger-ui/
The Data Preparation API page opens and operations are
classified into different categories as shown below:
-
Click a category name to display the operation list under the
category.
-
From the category list:
Select |
To |
Show/Hide
|
Show or hide all operations |
List Operations
|
Expand or collapse the operation list |
Expand Operations
|
Expand the details of an operation |
-
Start testing the execution of different operations.