Accessing the Talend Dictionary Service REST API documentation - 7.0

Talend Data Stewardship User Guide

English (United States)
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
Talend Data Stewardship
Administration and Monitoring > Managing users
Data Governance > Assigning tasks
Data Governance > Managing campaigns
Data Governance > Managing data models
Data Quality and Preparation > Handling tasks
Installation and Upgrade

REST API simplifies your interaction with the data stored on the Talend Dictionary Service server by using a number of methods or request types.

You can access all REST API documentation pages based on Swagger and run requests.


  1. Start Talend Dictionary Service.
  2. Open a web browser and enter the following URL, where <host> and <port> correspond to the URL of your Talend Dictionary Service instance:
    By default, the port used is 8187.

    The Talend Dictionary Service REST API documentation page opens and operations are classified into different categories:

  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 authentication you got when you logged in as part of your authorization header. For example: curl -X GET --header 'Authorization: Bearer <token>' --header 'Accept: application/json' 'http://localhost:8187/categories?caseSensitive=false&isExact=false'