Skip to main content Skip to complementary content

Accessing the Talend Data Preparation REST API documentation

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:

    Data Preparation API page opened with operations.
  2. Click a category name to display the operation list under the category.
  3. From the category list:
    • Select Show/Hide to show or hide all operations.
    • Select List Operations to expand or collapse the operation list.
    • Select Expand Operations to expand the details of an operation.
  4. Start testing the execution of different operations.
  5. To be able to call the PUT, POST or DELETE methods, you need to use a GET method to retrieve the XSRF token. Start by pressing F12 to open the Console of your browser.
  6. Click Try it out in a GET method documentation next to Parameters.
  7. Fill in the fields requested.
  8. Click Execute.
  9. In the Console, click the URL of your request.
  10. Under Request Headers >cookie, retrieve the XSRF-TOKEN.
    XSRF Token highlighted in the Request Headers cookie.
  11. In the Talend Cloud Data Preparation documentation page, click the opened lock and paste your XSRF token.
  12. Click Authorize.
    Available authorizations dialog box opened.
  13. You can now call GET, PUT, POST and DELETE methods.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – please let us know!

Leave your feedback here