Accessing the Talend Data Preparation REST API documentation - Cloud

Talend Cloud Data Preparation User Guide

EnrichVersion
Cloud
EnrichProdName
Talend Cloud
EnrichPlatform
Talend Data Preparation
task
Administration and Monitoring > Managing connections
Data Quality and Preparation > Cleansing data
Data Quality and Preparation > Managing datasets

REST API simplifies your interaction with the data stored in Talend Cloud Data Preparation 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. Open a Web browser and enter the URL corresponding to your region, following this pattern: https://tdp.<region>.cloud.talend.com/swagger-ui/.
    You'll find a list of the URLs to use for each data center in Talend Cloud regions and URLs.

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

  2. Click a category name to display the operation list under the category.
  3. 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
  4. Start testing the execution of different operations.
    Important: To call the PUT, POST and DELETE methods, you need to enter an X-XSRF-TOKEN in the pop-up window that opens and click Authorize. The token can be retrieved with any GET request on the server.