Accessing the Talend Data Preparation REST API documentation

Talend Data Preparation User Guide

author
Talend Documentation Team
EnrichVersion
6.4
2.1
EnrichProdName
Talend Real-Time Big Data Platform
Talend Big Data Platform
Talend MDM Platform
Talend Data Fabric
Talend ESB
Talend Big Data
Talend Data Services Platform
Talend Data Integration
Talend Data Management Platform
task
Data Quality and Preparation > Cleansing data
EnrichPlatform
Talend Data Preparation

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.

Procedure

  1. Open the <Installation_Path>/dataprep/config/application.properties configuration file.
  2. Set the value for the service.documentation parameter to true.
    # 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
  3. Restart Talend Data Preparation.
  4. Open a Web browser window and enter the following URL, where host and port correspond to the URL of your Talend Data Preparation instance:
    http://<host>:<port>/docs/index.html

    The Talend Data Preparation - API page opens and operations are classified into different categories as shown below:

  5. Click a category name to display the operation list under the category.
  6. Start testing the execution of different operations.