Accessing Talend Dictionary Service 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 on Talend Dictionary Service 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 also download a JSON file from any of the REST API documentation pages.

Before you begin

You have logged in to Talend Data Stewardship or Talend Data Preparation.

Procedure

  1. Open a Web browser and enter the following URI: https://tds.{region}.cloud.talend.com/docs/api/swagger-ui.html.

    You'll find a list of the URLs to use for each data center in Talend Cloud regions and URLs.

  2. From the field on top of the page, select Semantic Service to open the Talend Dictionary Service documentation page where operations are classified into different categories.

    Example

  3. Click a category name to display the operation list under the category.
  4. Click user-controller > /user/login and use your credentials to log in.
    In the Response Headers area, you get a bearer authentication.
  5. Start testing the execution of different operations.

    To get results from the executed operations, use the Curl command from the response.

    Include the bearer token you got when you logged in as part of your authorization header.

    Example

    curl -X GET --header 'Authorization: Bearer <token>' --header 'Accept: application/json' 'http://<host>:<port>/categories?caseSensitive=false&isExact=false'