Accessing the Talend Data Preparation REST API documentation - 8.0

Talend Data Preparation User Guide

Version
8.0
Language
English (United States)
Product
Talend Big Data
Talend Big Data Platform
Talend Data Fabric
Talend Data Integration
Talend Data Management Platform
Talend Data Services Platform
Talend ESB
Talend MDM Platform
Talend Real-Time Big Data Platform
Module
Talend Data Preparation
Content
Data Quality and Preparation > Cleansing data

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

  1. 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.
  2. 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:

  3. Click a category name to display the operation list under the category.
  4. 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
  5. Start testing the execution of different operations.