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.
First, you will have to enable access to Swagger by editing a parameter in the Talend Data Preparation configuration file.
- Open the <Installation_Path>/dataprep/config/application.properties configuration file.
Set the value for the
# Service documentation service.documentation=true service.documentation.name=Talend Data Preparation - API service.documentation.description=This service exposes high level services that may involve services orchestration. service.paths=api
- Restart Talend Data Preparation.
Open a Web browser window and enter the following URL, where host and port
correspond to the URL of your Talend Data Preparation instance:
The Talend 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.
- Start testing the execution of different operations.